Job Download Endpoint

This returns the job details in the specified file format.

Note that only the submitted jobs can be downloaded.

GET https://cabinetry.online/api/job/{jobid}/download[?type={type}]

Parameters

Field Type Default Description
jobid integer ID of the job to download
type string csv Format to download the job in

File Formats

Code Description
csv CSV format
xml XML format
json JSON format

Note that the structure and content of the data returned is identical in all three formats, the only difference between the three is the formatting of that data.

Response

The data returned is identical to the data in the CSV files downloadable within the application.

Response status codes

HTTP status code Meaning
200 Success, data was retrieved successfully
403 UnAuthorized Access, Record is not accessible by this user
404 Not Found, Record not found

Examples

GET https://cabinetry.online/api/job/1234567/download?type=csv
JobNumber:,1234567,JobName:,TestJob,Status:,"Pending Approval",Description:,,CustomerName:,"Customer Name","Manufacturer Name:","Manufacturer Name",InvoiceTo:,"Customer Name",OrderDate:,"14th May 2020 at 4:09pm",ExpectedDeliveryDate:,-,DispatchMethod:,Pick-up,ContactNumber:,0123456789
RoomNumber:,1,RoomName:,"Room 1",RoomDescription:,,CompanyLabel:,"Customer Name 0123456789",InteriorMaterial:,"Bestwood Embossed HMRPB 16 Allure",ExteriorMaterial:,"Bestwood Embossed HMRPB 16 Allure",InteriorEdging:,"Bestwood Gloss 1 Arctic Ice",ExteriorEdging:,"Bestwood VelvetLaser 1 Allure",DoorDwrProductName:,"Flat Panel",HingeSeries:,"Salice Knock In",DrawerSystem:,"Blum Metabox",ToeKickHeight:,0
RoomProductNo:,1-1.00,Type:,"Door w/ Hinge Holes",ProcessName:,Door_dzt,ProductDescription:,Door,Quantity:,1,ProductHeight:,750,ProductWidth:,750,ExteriorMaterial:,"Bestwood Embossed HMRPB 16 Allure",ExteriorEdging:,"Bestwood VelvetLaser 1 Allure",DoorDwrEdgingLeft:,Yes,DoorDwrEdgingRight:,Yes,DoorDwrEdgingTop:,Yes,DoorDwrEdgingBottom:,Yes,ExcludeHardware:,Yes,SpecificHingeHeights:,None,DoorHangType:,Single,DoorHang:,None,HingeSeries:,"Salice Knock In",DoorDwrProductName:,"Flat Panel",AdvancedDoorOptions:,BWT:55;BWL:55;BWR:55;BWB:55;BET:2;BEL:2;BER:2;BEB:2;SP1:0
RoomProductNo:,1-2.00,Type:,"Manual Panel",ProcessName:,Pan,ProductDescription:,Panel,Quantity:,1,ProductLength:,750,ProductWidth:,750,ExteriorMaterial:,"Bestwood Embossed HMRPB 16 Allure",ExteriorEdging:,"Bestwood VelvetLaser 1 Allure",ExteriorEdgeFront:,No,ExteriorEdgeBack:,No,ExteriorEdgeLeft:,No,ExteriorEdgeRight:,No,ExcludeHardware:,Yes
RoomProductNo:,1-3.00,Type:,"Manual Panel",ProcessName:,Pan,ProductDescription:,Panel,Quantity:,1,ProductLength:,750,ProductWidth:,750,ExteriorMaterial:,"Bestwood Embossed HMRPB 16 Allure",ExteriorEdging:,"Bestwood VelvetLaser 1 Allure",ExteriorEdgeFront:,No,ExteriorEdgeBack:,No,ExteriorEdgeLeft:,No,ExteriorEdgeRight:,No,ExcludeHardware:,Yes,AdvancedDoorOptions:,BWT:55;BWL:55;BWR:55;BWB:55;BET:0;BEL:0;BER:0;BEB:0;SP1:0
RoomProductNo:,1-4.00,Type:,"Door w/ Hinge Holes",ProcessName:,Door_dzt,ProductDescription:,Door,Quantity:,1,ProductHeight:,750,ProductWidth:,750,ExteriorMaterial:,"Bestwood Embossed HMRPB 16 Allure",ExteriorEdging:,"Bestwood VelvetLaser 1 Allure",DoorDwrEdgingLeft:,Yes,DoorDwrEdgingRight:,Yes,DoorDwrEdgingTop:,Yes,DoorDwrEdgingBottom:,Yes,ExcludeHardware:,Yes,SpecificHingeHeights:,None,DoorHangType:,Single,DoorHang:,None,HingeSeries:,"Salice Knock In",DoorDwrProductName:,"Flat Panel"