POST api/Agent/MicroApp/OnWayAppointment/Instruction/Cancel
撤消一个在途的预约指令(1、将预约指令标识为“已撤消”,2、将预约指令从在途预约移动到历史预约中)。
Request Information
URI Parameters
None.
Body Parameters
被撤消的预约的参数.
AgentOnwayAppointmentCancelParmName | Description | Type | Additional information |
---|---|---|---|
AppointmentId |
预约的ID。 |
integer |
Required |
ReturnBackGroupRequestReplay |
当预约有组长请求的回复时,是否同时撤消组长请求的回复。1表示是。 |
string |
Max length: 1 |
Request Formats
application/json, text/json
Sample:
{ "AppointmentId": 1, "ReturnBackGroupRequestReplay": "sample string 2" }
application/xml, text/xml
Sample:
<AgentOnwayAppointmentCancelParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalScience.DataTransfer.Flowmeter.MicroApp"> <AppointmentId>1</AppointmentId> <ReturnBackGroupRequestReplay>sample string 2</ReturnBackGroupRequestReplay> </AgentOnwayAppointmentCancelParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.
Response Information
Resource Description
撤消一个在途的预约指令(1、将预约指令标识为“已撤消”,2、将预约指令从在途预约移动到历史预约中)。
CommonOperationResultName | Description | Type | Additional information |
---|---|---|---|
errcode |
错误代码,通常0表示成功,其他值表示错误。 |
integer |
None. |
errmsg |
错误描述,当errcode不为零时,此值可以用于呈现给用户。 |
string |
None. |
tag |
操作同时,服务器端需要返回的其他值。 |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "errcode": 1, "errmsg": "sample string 2", "tag": "sample string 3" }
application/xml, text/xml
Sample:
<CommonOperationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalScience.DataTransfer"> <errcode>1</errcode> <errmsg>sample string 2</errmsg> <tag>sample string 3</tag> </CommonOperationResult>
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.