POST api/WorkOrders/QuickJob

Quick WorkOrder / Job

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ApiToken	string	None.
WorkOrderNo	string	None.
WorkOrderTitle	string	None.
WorkOrderStatusID	integer	None.
MaintenanceType	string	None.
Timezone	string	None.
TimeZoneFraction	decimal number	None.
StartDate	string	None.
StartTime	string	None.
EndDate	string	None.
EndTime	string	None.
LocationID	integer	None.
MarketingCampaignID	integer	None.
WorkOrderDescription	string	None.
AssignedCompanyID	Collection of integer	None.
AssignedEmployeeID	Collection of integer	None.
RequesterType	integer	None.
RequesterID	integer	None.
RequesterCustomerID	integer	None.
RequesterEmployeeID	integer	None.
RequesterName	string	None.
RequesterEmail	string	None.
RequesterPhoneCode	string	None.
RequesterPhoneNumber	string	None.
CustomerType	integer	None.
CustomerServiceAddressID	integer	None.
CustomerAddressType	integer	None.
Address1	string	None.
Address2	string	None.
CountryID	integer	None.
StateID	integer	None.
CityID	integer	None.
Zipcode	string	None.
Building	string	None.
RechnungAddress	string	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
BillToAddress1	string	None.
BillToAddress2	string	None.
BillToCountryID	integer	None.
BillToStateID	integer	None.
BillToCityID	integer	None.
BillToZipcode	string	None.
AssignedTags	Collection of WorkOrderTagList	None.
IsJob	boolean	None.
AddedBy	integer	None.
IsStartJob	boolean	None.
IsServiceAutomatedJob	boolean	None.
Zusatzliche_Additional_Informationen	string	None.
WorkOrderAsset	Collection of MappedAsset	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "apiToken": "sample string 1",
  "workOrderNo": "sample string 2",
  "workOrderTitle": "sample string 3",
  "workOrderStatusID": 1,
  "maintenanceType": "sample string 4",
  "timezone": "sample string 5",
  "timeZoneFraction": 1.0,
  "startDate": "sample string 6",
  "startTime": "sample string 7",
  "endDate": "sample string 8",
  "endTime": "sample string 9",
  "locationID": 1,
  "marketingCampaignID": 1,
  "workOrderDescription": "sample string 10",
  "assignedCompanyID": [
    1,
    2
  ],
  "assignedEmployeeID": [
    1,
    2
  ],
  "requesterType": 1,
  "requesterID": 1,
  "requesterCustomerID": 1,
  "requesterEmployeeID": 1,
  "requesterName": "sample string 11",
  "requesterEmail": "sample string 12",
  "requesterPhoneCode": "sample string 13",
  "requesterPhoneNumber": "sample string 14",
  "customerType": 1,
  "customerServiceAddressID": 1,
  "customerAddressType": 1,
  "address1": "sample string 15",
  "address2": "sample string 16",
  "countryID": 1,
  "stateID": 1,
  "cityID": 1,
  "zipcode": "sample string 17",
  "building": "sample string 18",
  "rechnungAddress": "sample string 19",
  "latitude": 1.0,
  "longitude": 1.0,
  "billToAddress1": "sample string 20",
  "billToAddress2": "sample string 21",
  "billToCountryID": 1,
  "billToStateID": 1,
  "billToCityID": 1,
  "billToZipcode": "sample string 22",
  "assignedTags": [
    {
      "tagID": 1
    },
    {
      "tagID": 1
    }
  ],
  "isJob": true,
  "addedBy": 1,
  "isStartJob": true,
  "isServiceAutomatedJob": true,
  "zusatzliche_Additional_Informationen": "sample string 26",
  "workOrderAsset": [
    {
      "assetId": 1,
      "equipmentNr": "sample string 2",
      "assetsClassID": 1
    },
    {
      "assetId": 1,
      "equipmentNr": "sample string 2",
      "assetsClassID": 1
    }
  ]
}

application/xml, text/xml

Sample:

<QuickJobCreationInsertRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <AddedBy>1</AddedBy>
  <Address1>sample string 15</Address1>
  <Address2>sample string 16</Address2>
  <ApiToken>sample string 1</ApiToken>
  <AssignedCompanyID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AssignedCompanyID>
  <AssignedEmployeeID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AssignedEmployeeID>
  <AssignedTags>
    <WorkOrderTagList>
      <TagID>1</TagID>
    </WorkOrderTagList>
    <WorkOrderTagList>
      <TagID>1</TagID>
    </WorkOrderTagList>
  </AssignedTags>
  <BillToAddress1>sample string 20</BillToAddress1>
  <BillToAddress2>sample string 21</BillToAddress2>
  <BillToCityID>1</BillToCityID>
  <BillToCountryID>1</BillToCountryID>
  <BillToStateID>1</BillToStateID>
  <BillToZipcode>sample string 22</BillToZipcode>
  <Building>sample string 18</Building>
  <CityID>1</CityID>
  <CountryID>1</CountryID>
  <CustomerAddressType>1</CustomerAddressType>
  <CustomerServiceAddressID>1</CustomerServiceAddressID>
  <CustomerType>1</CustomerType>
  <EndDate>sample string 8</EndDate>
  <EndTime>sample string 9</EndTime>
  <IsJob>true</IsJob>
  <IsServiceAutomatedJob>true</IsServiceAutomatedJob>
  <IsStartJob>true</IsStartJob>
  <Latitude>1</Latitude>
  <LocationID>1</LocationID>
  <Longitude>1</Longitude>
  <MaintenanceType>sample string 4</MaintenanceType>
  <MarketingCampaignID>1</MarketingCampaignID>
  <RechnungAddress>sample string 19</RechnungAddress>
  <RequesterCustomerID>1</RequesterCustomerID>
  <RequesterEmail>sample string 12</RequesterEmail>
  <RequesterEmployeeID>1</RequesterEmployeeID>
  <RequesterID>1</RequesterID>
  <RequesterName>sample string 11</RequesterName>
  <RequesterPhoneCode>sample string 13</RequesterPhoneCode>
  <RequesterPhoneNumber>sample string 14</RequesterPhoneNumber>
  <RequesterType>1</RequesterType>
  <StartDate>sample string 6</StartDate>
  <StartTime>sample string 7</StartTime>
  <StateID>1</StateID>
  <TimeZoneFraction>1</TimeZoneFraction>
  <Timezone>sample string 5</Timezone>
  <WorkOrderAsset xmlns:d2p1="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">
    <d2p1:MappedAsset>
      <d2p1:AssetId>1</d2p1:AssetId>
      <d2p1:AssetsClassID>1</d2p1:AssetsClassID>
      <d2p1:EquipmentNr>sample string 2</d2p1:EquipmentNr>
    </d2p1:MappedAsset>
    <d2p1:MappedAsset>
      <d2p1:AssetId>1</d2p1:AssetId>
      <d2p1:AssetsClassID>1</d2p1:AssetsClassID>
      <d2p1:EquipmentNr>sample string 2</d2p1:EquipmentNr>
    </d2p1:MappedAsset>
  </WorkOrderAsset>
  <WorkOrderDescription>sample string 10</WorkOrderDescription>
  <WorkOrderNo>sample string 2</WorkOrderNo>
  <WorkOrderStatusID>1</WorkOrderStatusID>
  <WorkOrderTitle>sample string 3</WorkOrderTitle>
  <Zipcode>sample string 17</Zipcode>
  <Zusatzliche_Additional_Informationen>sample string 26</Zusatzliche_Additional_Informationen>
</QuickJobCreationInsertRequestModel>

multipart/form-data

Sample:

<QuickJobCreationInsertRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><AddedBy>1</AddedBy><Address1>sample string 15</Address1><Address2>sample string 16</Address2><ApiToken>sample string 1</ApiToken><AssignedCompanyID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:long>1</d2p1:long><d2p1:long>2</d2p1:long></AssignedCompanyID><AssignedEmployeeID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:long>1</d2p1:long><d2p1:long>2</d2p1:long></AssignedEmployeeID><AssignedTags><WorkOrderTagList><TagID>1</TagID></WorkOrderTagList><WorkOrderTagList><TagID>1</TagID></WorkOrderTagList></AssignedTags><BillToAddress1>sample string 20</BillToAddress1><BillToAddress2>sample string 21</BillToAddress2><BillToCityID>1</BillToCityID><BillToCountryID>1</BillToCountryID><BillToStateID>1</BillToStateID><BillToZipcode>sample string 22</BillToZipcode><Building>sample string 18</Building><CityID>1</CityID><CountryID>1</CountryID><CustomerAddressType>1</CustomerAddressType><CustomerServiceAddressID>1</CustomerServiceAddressID><CustomerType>1</CustomerType><EndDate>sample string 8</EndDate><EndTime>sample string 9</EndTime><IsJob>true</IsJob><IsServiceAutomatedJob>true</IsServiceAutomatedJob><IsStartJob>true</IsStartJob><Latitude>1</Latitude><LocationID>1</LocationID><Longitude>1</Longitude><MaintenanceType>sample string 4</MaintenanceType><MarketingCampaignID>1</MarketingCampaignID><RechnungAddress>sample string 19</RechnungAddress><RequesterCustomerID>1</RequesterCustomerID><RequesterEmail>sample string 12</RequesterEmail><RequesterEmployeeID>1</RequesterEmployeeID><RequesterID>1</RequesterID><RequesterName>sample string 11</RequesterName><RequesterPhoneCode>sample string 13</RequesterPhoneCode><RequesterPhoneNumber>sample string 14</RequesterPhoneNumber><RequesterType>1</RequesterType><StartDate>sample string 6</StartDate><StartTime>sample string 7</StartTime><StateID>1</StateID><TimeZoneFraction>1</TimeZoneFraction><Timezone>sample string 5</Timezone><WorkOrderAsset xmlns:d2p1="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><d2p1:MappedAsset><d2p1:AssetId>1</d2p1:AssetId><d2p1:AssetsClassID>1</d2p1:AssetsClassID><d2p1:EquipmentNr>sample string 2</d2p1:EquipmentNr></d2p1:MappedAsset><d2p1:MappedAsset><d2p1:AssetId>1</d2p1:AssetId><d2p1:AssetsClassID>1</d2p1:AssetsClassID><d2p1:EquipmentNr>sample string 2</d2p1:EquipmentNr></d2p1:MappedAsset></WorkOrderAsset><WorkOrderDescription>sample string 10</WorkOrderDescription><WorkOrderNo>sample string 2</WorkOrderNo><WorkOrderStatusID>1</WorkOrderStatusID><WorkOrderTitle>sample string 3</WorkOrderTitle><Zipcode>sample string 17</Zipcode><Zusatzliche_Additional_Informationen>sample string 26</Zusatzliche_Additional_Informationen></QuickJobCreationInsertRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WorkOrderInsertUpdateResponseModel

Name	Type	Additional information
WorkOrderNo	string	None.
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "workOrderNo": "sample string 1",
  "returnID": 2,
  "message": "sample string 3",
  "successful": true,
  "code": 5,
  "totalRecord": 6
}

application/xml, text/xml

Sample:

<WorkOrderInsertUpdateResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>5</Code>
  <Message>sample string 3</Message>
  <ReturnID>2</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>6</TotalRecord>
  <WorkOrderNo>sample string 1</WorkOrderNo>
</WorkOrderInsertUpdateResponseModel>

multipart/form-data

Sample:

<WorkOrderInsertUpdateResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>5</Code><Message>sample string 3</Message><ReturnID>2</ReturnID><Successful>true</Successful><TotalRecord>6</TotalRecord><WorkOrderNo>sample string 1</WorkOrderNo></WorkOrderInsertUpdateResponseModel>