POST api/Incident
Insert incident
Request Information
URI Parameters
None.
Body Parameters
IncidentInsertRequestModelName | Description | Type | Additional information |
---|---|---|---|
APIToken | string |
None. |
|
IncidentType | integer |
None. |
|
RequestType | integer |
None. |
|
ImpactTitle | string |
None. |
|
UrgencyTitle | string |
None. |
|
PriorityTitle | string |
None. |
|
RequesterName | string |
None. |
|
RequesterContact | string |
None. |
|
RequesterEmail | string |
None. |
|
ShortLocationName | string |
None. |
|
CategoryName | string |
None. |
|
SubCategoryName | string |
None. |
|
Subject | string |
None. |
|
Description | string |
None. |
|
DueByDate | string |
Matching regular expression pattern: (([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))|([12]\d{3}\/(0[1-9]|1[0-2])\/(0[1-9]|[12]\d|3[01]))) |
|
RequesterTypeId | integer |
None. |
|
JobLocationLatitude | decimal number |
None. |
|
JobLocationLongitude | decimal number |
None. |
|
JobLocationAddress | string |
None. |
|
RequesterId | integer |
None. |
|
RequesterEmployeeID | integer |
None. |
|
RequesterCustomerID | integer |
None. |
|
RequesterSubContractorID | integer |
None. |
|
DepartmentId | integer |
None. |
|
AssetList | Collection of RequestAssetList |
None. |
|
TaskFileBase64 | string |
None. |
|
FileType | string |
None. |
|
speechLanguageInput | string |
None. |
|
RequestAssetType | integer |
None. |
|
RentalRequest | Collection of RentalRequestModel |
None. |
|
Custom1 | string |
None. |
|
Custom2 | string |
None. |
|
Custom3 | string |
None. |
|
Custom4 | string |
None. |
|
Custom5 | string |
None. |
|
Custom6 | string |
None. |
|
Custom7 | string |
None. |
|
Custom8 | string |
None. |
|
Custom9 | string |
None. |
|
Custom10 | string |
None. |
Request Formats
application/json, text/json, text/plain, text/html
Sample:
{ "apiToken": "sample string 1", "incidentType": 2, "requestType": 1, "impactTitle": "sample string 3", "urgencyTitle": "sample string 4", "priorityTitle": "sample string 5", "requesterName": "sample string 6", "requesterContact": "sample string 7", "requesterEmail": "sample string 8", "shortLocationName": "sample string 9", "categoryName": "sample string 10", "subCategoryName": "sample string 11", "subject": "sample string 12", "description": "sample string 13", "dueByDate": "sample string 14", "requesterTypeId": 1, "jobLocationLatitude": 1.0, "jobLocationLongitude": 1.0, "jobLocationAddress": "sample string 15", "requesterId": 1, "requesterEmployeeID": 1, "requesterCustomerID": 1, "requesterSubContractorID": 1, "departmentId": 1, "assetList": [ { "incidentId": 1, "assetId": 1, "assetName": "sample string 1" }, { "incidentId": 1, "assetId": 1, "assetName": "sample string 1" } ], "taskFileBase64": "sample string 16", "fileType": "sample string 17", "speechLanguageInput": "sample string 18", "requestAssetType": 1, "rentalRequest": [ { "incidentRequestRentalItemID": 1, "requestItemType": 1, "productID": 1, "productSearchcode": "sample string 1", "itemName": "sample string 2", "quantity": 1 }, { "incidentRequestRentalItemID": 1, "requestItemType": 1, "productID": 1, "productSearchcode": "sample string 1", "itemName": "sample string 2", "quantity": 1 } ], "custom1": "sample string 19", "custom2": "sample string 20", "custom3": "sample string 21", "custom4": "sample string 22", "custom5": "sample string 23", "custom6": "sample string 24", "custom7": "sample string 25", "custom8": "sample string 26", "custom9": "sample string 27", "custom10": "sample string 28" }
application/xml, text/xml
Sample:
<IncidentInsertRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"> <APIToken>sample string 1</APIToken> <AssetList> <RequestAssetList> <AssetId>1</AssetId> <AssetName>sample string 1</AssetName> <IncidentId>1</IncidentId> </RequestAssetList> <RequestAssetList> <AssetId>1</AssetId> <AssetName>sample string 1</AssetName> <IncidentId>1</IncidentId> </RequestAssetList> </AssetList> <CategoryName>sample string 10</CategoryName> <Custom1>sample string 19</Custom1> <Custom10>sample string 28</Custom10> <Custom2>sample string 20</Custom2> <Custom3>sample string 21</Custom3> <Custom4>sample string 22</Custom4> <Custom5>sample string 23</Custom5> <Custom6>sample string 24</Custom6> <Custom7>sample string 25</Custom7> <Custom8>sample string 26</Custom8> <Custom9>sample string 27</Custom9> <DepartmentId>1</DepartmentId> <Description>sample string 13</Description> <DueByDate>sample string 14</DueByDate> <FileType>sample string 17</FileType> <ImpactTitle>sample string 3</ImpactTitle> <IncidentType>2</IncidentType> <JobLocationAddress>sample string 15</JobLocationAddress> <JobLocationLatitude>1</JobLocationLatitude> <JobLocationLongitude>1</JobLocationLongitude> <PriorityTitle>sample string 5</PriorityTitle> <RentalRequest> <RentalRequestModel> <IncidentRequestRentalItemID>1</IncidentRequestRentalItemID> <ItemName>sample string 2</ItemName> <ProductID>1</ProductID> <ProductSearchcode>sample string 1</ProductSearchcode> <Quantity>1</Quantity> <RequestItemType>1</RequestItemType> </RentalRequestModel> <RentalRequestModel> <IncidentRequestRentalItemID>1</IncidentRequestRentalItemID> <ItemName>sample string 2</ItemName> <ProductID>1</ProductID> <ProductSearchcode>sample string 1</ProductSearchcode> <Quantity>1</Quantity> <RequestItemType>1</RequestItemType> </RentalRequestModel> </RentalRequest> <RequestAssetType>1</RequestAssetType> <RequestType>1</RequestType> <RequesterContact>sample string 7</RequesterContact> <RequesterCustomerID>1</RequesterCustomerID> <RequesterEmail>sample string 8</RequesterEmail> <RequesterEmployeeID>1</RequesterEmployeeID> <RequesterId>1</RequesterId> <RequesterName>sample string 6</RequesterName> <RequesterSubContractorID>1</RequesterSubContractorID> <RequesterTypeId>1</RequesterTypeId> <ShortLocationName>sample string 9</ShortLocationName> <SubCategoryName>sample string 11</SubCategoryName> <Subject>sample string 12</Subject> <TaskFileBase64>sample string 16</TaskFileBase64> <UrgencyTitle>sample string 4</UrgencyTitle> <speechLanguageInput>sample string 18</speechLanguageInput> </IncidentInsertRequestModel>
multipart/form-data
Sample:
<IncidentInsertRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><APIToken>sample string 1</APIToken><AssetList><RequestAssetList><AssetId>1</AssetId><AssetName>sample string 1</AssetName><IncidentId>1</IncidentId></RequestAssetList><RequestAssetList><AssetId>1</AssetId><AssetName>sample string 1</AssetName><IncidentId>1</IncidentId></RequestAssetList></AssetList><CategoryName>sample string 10</CategoryName><Custom1>sample string 19</Custom1><Custom10>sample string 28</Custom10><Custom2>sample string 20</Custom2><Custom3>sample string 21</Custom3><Custom4>sample string 22</Custom4><Custom5>sample string 23</Custom5><Custom6>sample string 24</Custom6><Custom7>sample string 25</Custom7><Custom8>sample string 26</Custom8><Custom9>sample string 27</Custom9><DepartmentId>1</DepartmentId><Description>sample string 13</Description><DueByDate>sample string 14</DueByDate><FileType>sample string 17</FileType><ImpactTitle>sample string 3</ImpactTitle><IncidentType>2</IncidentType><JobLocationAddress>sample string 15</JobLocationAddress><JobLocationLatitude>1</JobLocationLatitude><JobLocationLongitude>1</JobLocationLongitude><PriorityTitle>sample string 5</PriorityTitle><RentalRequest><RentalRequestModel><IncidentRequestRentalItemID>1</IncidentRequestRentalItemID><ItemName>sample string 2</ItemName><ProductID>1</ProductID><ProductSearchcode>sample string 1</ProductSearchcode><Quantity>1</Quantity><RequestItemType>1</RequestItemType></RentalRequestModel><RentalRequestModel><IncidentRequestRentalItemID>1</IncidentRequestRentalItemID><ItemName>sample string 2</ItemName><ProductID>1</ProductID><ProductSearchcode>sample string 1</ProductSearchcode><Quantity>1</Quantity><RequestItemType>1</RequestItemType></RentalRequestModel></RentalRequest><RequestAssetType>1</RequestAssetType><RequestType>1</RequestType><RequesterContact>sample string 7</RequesterContact><RequesterCustomerID>1</RequesterCustomerID><RequesterEmail>sample string 8</RequesterEmail><RequesterEmployeeID>1</RequesterEmployeeID><RequesterId>1</RequesterId><RequesterName>sample string 6</RequesterName><RequesterSubContractorID>1</RequesterSubContractorID><RequesterTypeId>1</RequesterTypeId><ShortLocationName>sample string 9</ShortLocationName><SubCategoryName>sample string 11</SubCategoryName><Subject>sample string 12</Subject><TaskFileBase64>sample string 16</TaskFileBase64><UrgencyTitle>sample string 4</UrgencyTitle><speechLanguageInput>sample string 18</speechLanguageInput></IncidentInsertRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IncidentDataModelName | Description | Type | Additional information |
---|---|---|---|
CaseId | 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:
{ "caseId": "sample string 1", "returnID": 2, "message": "sample string 3", "successful": true, "code": 5, "totalRecord": 6 }
application/xml, text/xml
Sample:
<IncidentDataModel 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> <CaseId>sample string 1</CaseId> </IncidentDataModel>
multipart/form-data
Sample:
<IncidentDataModel 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><CaseId>sample string 1</CaseId></IncidentDataModel>