POST api/IncidentNote
Save Incident Note List
Request Information
URI Parameters
None.
Body Parameters
IncidentSaveRequestModelName | Description | Type | Additional information |
---|---|---|---|
APIkey | string |
None. |
|
NoteID | integer |
None. |
|
IncidentId | integer |
None. |
|
IncidentType | integer |
None. |
|
Note | string |
Required |
|
IsActive | integer |
None. |
|
UserID | integer |
Required |
|
Base64Files | Collection of FileBase64RequestModel |
None. |
|
CaseID | string |
None. |
|
TaggedUser | string |
None. |
Request Formats
application/json, text/json, text/plain, text/html
Sample:
{ "apIkey": "sample string 1", "noteID": 1, "incidentId": 1, "incidentType": 1, "note": "sample string 2", "isActive": 3, "userID": 4, "base64Files": [ { "base64String": "sample string 1", "fileImportID": 1, "actualFileName": "sample string 2", "renamedFileName": "sample string 3", "fileExtension": "sample string 4" }, { "base64String": "sample string 1", "fileImportID": 1, "actualFileName": "sample string 2", "renamedFileName": "sample string 3", "fileExtension": "sample string 4" } ], "caseID": "sample string 5", "taggedUser": "sample string 6" }
application/xml, text/xml
Sample:
<IncidentSaveRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"> <APIkey>sample string 1</APIkey> <Base64Files> <FileBase64RequestModel> <ActualFileName>sample string 2</ActualFileName> <Base64String>sample string 1</Base64String> <FileExtension>sample string 4</FileExtension> <FileImportID>1</FileImportID> <RenamedFileName>sample string 3</RenamedFileName> </FileBase64RequestModel> <FileBase64RequestModel> <ActualFileName>sample string 2</ActualFileName> <Base64String>sample string 1</Base64String> <FileExtension>sample string 4</FileExtension> <FileImportID>1</FileImportID> <RenamedFileName>sample string 3</RenamedFileName> </FileBase64RequestModel> </Base64Files> <CaseID>sample string 5</CaseID> <IncidentId>1</IncidentId> <IncidentType>1</IncidentType> <IsActive>3</IsActive> <Note>sample string 2</Note> <NoteID>1</NoteID> <TaggedUser>sample string 6</TaggedUser> <UserID>4</UserID> </IncidentSaveRequestModel>
multipart/form-data
Sample:
<IncidentSaveRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><APIkey>sample string 1</APIkey><Base64Files><FileBase64RequestModel><ActualFileName>sample string 2</ActualFileName><Base64String>sample string 1</Base64String><FileExtension>sample string 4</FileExtension><FileImportID>1</FileImportID><RenamedFileName>sample string 3</RenamedFileName></FileBase64RequestModel><FileBase64RequestModel><ActualFileName>sample string 2</ActualFileName><Base64String>sample string 1</Base64String><FileExtension>sample string 4</FileExtension><FileImportID>1</FileImportID><RenamedFileName>sample string 3</RenamedFileName></FileBase64RequestModel></Base64Files><CaseID>sample string 5</CaseID><IncidentId>1</IncidentId><IncidentType>1</IncidentType><IsActive>3</IsActive><Note>sample string 2</Note><NoteID>1</NoteID><TaggedUser>sample string 6</TaggedUser><UserID>4</UserID></IncidentSaveRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CommonResponseDataModelName | Description | Type | Additional information |
---|---|---|---|
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:
{ "returnID": 1, "message": "sample string 2", "successful": true, "code": 4, "totalRecord": 5 }
application/xml, text/xml
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"> <Code>4</Code> <Message>sample string 2</Message> <ReturnID>1</ReturnID> <Successful>true</Successful> <TotalRecord>5</TotalRecord> </CommonResponseDataModel>
multipart/form-data
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>