POST api/Order/Status
Request Information
URI Parameters
None.
Body Parameters
RouteStatusRequestModelName | Description | Type | Additional information |
---|---|---|---|
APIKey | string |
None. |
|
IsActive | integer |
None. |
|
SearchText | string |
None. |
|
PageNumber | integer |
None. |
|
PageSize | integer |
None. |
|
UsePaging | boolean |
None. |
Request Formats
application/json, text/json, text/plain, text/html
Sample:
{ "apiKey": "sample string 1", "isActive": 1, "searchText": "sample string 2", "pageNumber": 1, "pageSize": 1, "usePaging": true }
application/xml, text/xml
Sample:
<RouteStatusRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"> <IsActive xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">1</IsActive> <PageNumber xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">1</PageNumber> <PageSize xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">1</PageSize> <SearchText xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">sample string 2</SearchText> <UsePaging xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">true</UsePaging> <APIKey>sample string 1</APIKey> </RouteStatusRequestModel>
multipart/form-data
Sample:
<RouteStatusRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><IsActive xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">1</IsActive><PageNumber xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">1</PageNumber><PageSize xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">1</PageSize><SearchText xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">sample string 2</SearchText><UsePaging xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">true</UsePaging><APIKey>sample string 1</APIKey></RouteStatusRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
RoutePlanStatusResponceModelName | Description | Type | Additional information |
---|---|---|---|
routeStatus | Collection of RouteStatusVM |
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:
{ "routeStatus": [ { "statusName": "sample string 1", "id": 2 }, { "statusName": "sample string 1", "id": 2 } ], "returnID": 1, "message": "sample string 2", "successful": true, "code": 4, "totalRecord": 5 }
application/xml, text/xml
Sample:
<RoutePlanStatusResponceModel 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">4</Code> <Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 2</Message> <ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">1</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">5</TotalRecord> <routeStatus> <RouteStatusVM> <Id>2</Id> <StatusName>sample string 1</StatusName> </RouteStatusVM> <RouteStatusVM> <Id>2</Id> <StatusName>sample string 1</StatusName> </RouteStatusVM> </routeStatus> </RoutePlanStatusResponceModel>
multipart/form-data
Sample:
<RoutePlanStatusResponceModel 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">4</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 2</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">1</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">5</TotalRecord><routeStatus><RouteStatusVM><Id>2</Id><StatusName>sample string 1</StatusName></RouteStatusVM><RouteStatusVM><Id>2</Id><StatusName>sample string 1</StatusName></RouteStatusVM></routeStatus></RoutePlanStatusResponceModel>