POST api/WorkOrderStatus

Update Work Order Status

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AutoServiceMasterID	integer	Required
WorkOrderStatusID	integer	Required
StatusNote	string	None.
GeoPositionID	integer	None.
UserID	integer	None.
CompanyID	integer	None.
Latitude	decimal number	Required
Longitude	decimal number	Required
CompletionNoteID	integer	None.
CompletionNotes	string	None.
Problem	string	None.
Rootcause	string	None.
Solution	string	None.
AdminNotes	string	None.
ClosureCodeID	integer	None.
WorkOrderVisitID	integer	None.
VisitPurposeID	integer	None.
AdditionalRemark	string	None.
IsClosedSales	boolean	None.
IsCollectedFunds	boolean	None.
IsBuildAwareness	boolean	None.
IsCreatedAwareness	boolean	None.
TotalSales	decimal number	None.
TotalCollection	decimal number	None.
FollowUpReasonID	integer	None.
FollowUpDate	string	None.
FollowUpTime	string	None.
FollowUpComments	string	None.
IsCreatedNewOrder	boolean	None.
StatusChangedFrom	integer	None.
ApiToken	string	None.
StatusChangeDate	string	None.
StatusChangeTime	string	None.
AISummary	string	None.
IPAddress	string	None.
SendMailForApproval	boolean	None.
ApprovalEmailAddress	string	None.

Request Formats

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

Sample:

{
  "autoServiceMasterID": 1,
  "workOrderStatusID": 2,
  "statusNote": "sample string 3",
  "geoPositionID": 1,
  "userID": 1,
  "companyID": 1,
  "latitude": 1.0,
  "longitude": 1.0,
  "completionNoteID": 1,
  "completionNotes": "sample string 4",
  "problem": "sample string 5",
  "rootcause": "sample string 6",
  "solution": "sample string 7",
  "adminNotes": "sample string 8",
  "closureCodeID": 1,
  "workOrderVisitID": 1,
  "visitPurposeID": 1,
  "additionalRemark": "sample string 9",
  "isClosedSales": true,
  "isCollectedFunds": true,
  "isBuildAwareness": true,
  "isCreatedAwareness": true,
  "totalSales": 14.0,
  "totalCollection": 15.0,
  "followUpReasonID": 1,
  "followUpDate": "sample string 16",
  "followUpTime": "sample string 17",
  "followUpComments": "sample string 18",
  "isCreatedNewOrder": true,
  "statusChangedFrom": 1,
  "apiToken": "sample string 20",
  "statusChangeDate": "sample string 21",
  "statusChangeTime": "sample string 22",
  "aiSummary": "sample string 23",
  "ipAddress": "sample string 24",
  "sendMailForApproval": true,
  "approvalEmailAddress": "sample string 26"
}

application/xml, text/xml

Sample:

<WorkOrderStatusUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <AISummary>sample string 23</AISummary>
  <AdditionalRemark>sample string 9</AdditionalRemark>
  <AdminNotes>sample string 8</AdminNotes>
  <ApiToken>sample string 20</ApiToken>
  <ApprovalEmailAddress>sample string 26</ApprovalEmailAddress>
  <AutoServiceMasterID>1</AutoServiceMasterID>
  <ClosureCodeID>1</ClosureCodeID>
  <CompanyID>1</CompanyID>
  <CompletionNoteID>1</CompletionNoteID>
  <CompletionNotes>sample string 4</CompletionNotes>
  <FollowUpComments>sample string 18</FollowUpComments>
  <FollowUpDate>sample string 16</FollowUpDate>
  <FollowUpReasonID>1</FollowUpReasonID>
  <FollowUpTime>sample string 17</FollowUpTime>
  <GeoPositionID>1</GeoPositionID>
  <IPAddress>sample string 24</IPAddress>
  <IsBuildAwareness>true</IsBuildAwareness>
  <IsClosedSales>true</IsClosedSales>
  <IsCollectedFunds>true</IsCollectedFunds>
  <IsCreatedAwareness>true</IsCreatedAwareness>
  <IsCreatedNewOrder>true</IsCreatedNewOrder>
  <Latitude>1</Latitude>
  <Longitude>1</Longitude>
  <Problem>sample string 5</Problem>
  <Rootcause>sample string 6</Rootcause>
  <SendMailForApproval>true</SendMailForApproval>
  <Solution>sample string 7</Solution>
  <StatusChangeDate>sample string 21</StatusChangeDate>
  <StatusChangeTime>sample string 22</StatusChangeTime>
  <StatusChangedFrom>1</StatusChangedFrom>
  <StatusNote>sample string 3</StatusNote>
  <TotalCollection>15</TotalCollection>
  <TotalSales>14</TotalSales>
  <UserID>1</UserID>
  <VisitPurposeID>1</VisitPurposeID>
  <WorkOrderStatusID>2</WorkOrderStatusID>
  <WorkOrderVisitID>1</WorkOrderVisitID>
</WorkOrderStatusUpdateRequestModel>

multipart/form-data

Sample:

<WorkOrderStatusUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><AISummary>sample string 23</AISummary><AdditionalRemark>sample string 9</AdditionalRemark><AdminNotes>sample string 8</AdminNotes><ApiToken>sample string 20</ApiToken><ApprovalEmailAddress>sample string 26</ApprovalEmailAddress><AutoServiceMasterID>1</AutoServiceMasterID><ClosureCodeID>1</ClosureCodeID><CompanyID>1</CompanyID><CompletionNoteID>1</CompletionNoteID><CompletionNotes>sample string 4</CompletionNotes><FollowUpComments>sample string 18</FollowUpComments><FollowUpDate>sample string 16</FollowUpDate><FollowUpReasonID>1</FollowUpReasonID><FollowUpTime>sample string 17</FollowUpTime><GeoPositionID>1</GeoPositionID><IPAddress>sample string 24</IPAddress><IsBuildAwareness>true</IsBuildAwareness><IsClosedSales>true</IsClosedSales><IsCollectedFunds>true</IsCollectedFunds><IsCreatedAwareness>true</IsCreatedAwareness><IsCreatedNewOrder>true</IsCreatedNewOrder><Latitude>1</Latitude><Longitude>1</Longitude><Problem>sample string 5</Problem><Rootcause>sample string 6</Rootcause><SendMailForApproval>true</SendMailForApproval><Solution>sample string 7</Solution><StatusChangeDate>sample string 21</StatusChangeDate><StatusChangeTime>sample string 22</StatusChangeTime><StatusChangedFrom>1</StatusChangedFrom><StatusNote>sample string 3</StatusNote><TotalCollection>15</TotalCollection><TotalSales>14</TotalSales><UserID>1</UserID><VisitPurposeID>1</VisitPurposeID><WorkOrderStatusID>2</WorkOrderStatusID><WorkOrderVisitID>1</WorkOrderVisitID></WorkOrderStatusUpdateRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WorkOrderStatusSaveResponseDataModel

Name	Type	Additional information
CompletionNoteID	integer	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:

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

application/xml, text/xml

Sample:

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

multipart/form-data

Sample:

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