POST api/v1/banzaifieldservices/{PartnerId}/Appointment/ChangeStatusTasksAndServices
Change the Tasks status calling the boomi service and the services status by an internal update
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PartnerId |
The partner identifier: 1 = 'ePRICE' |
integer |
Required |
Body Parameters
ChangeStatusTasksAndServicesRequestName | Description | Type | Additional information |
---|---|---|---|
AppointmentId | integer |
None. |
|
Assignment | Assignment |
None. |
|
Task | TaskChangeStatus |
None. |
Request Formats
application/json, text/json
Sample:
{ "appointmentId": 1, "assignment": { "assignedEngineers": "sample string 1" }, "task": { "callID": "sample string 1", "comment": "sample string 2", "customVersion": 3, "customVersionSpecified": true, "endWorkDate": "sample string 5", "engineerNote": "sample string 6", "number": 7, "numberSpecified": true, "status": { "name": "sample string 1" }, "requiredServices": [ { "externalReference": "2a34d64d-5185-474a-83d1-b0d9f7de6389", "serviceType": "sample string 2", "status": "sample string 3" }, { "externalReference": "2a34d64d-5185-474a-83d1-b0d9f7de6389", "serviceType": "sample string 2", "status": "sample string 3" } ] } }
text/plain
Sample:
{"appointmentId":1,"assignment":{"assignedEngineers":"sample string 1"},"task":{"callID":"sample string 1","comment":"sample string 2","customVersion":3,"customVersionSpecified":true,"endWorkDate":"sample string 5","engineerNote":"sample string 6","number":7,"numberSpecified":true,"status":{"name":"sample string 1"},"requiredServices":[{"externalReference":"2a34d64d-5185-474a-83d1-b0d9f7de6389","serviceType":"sample string 2","status":"sample string 3"},{"externalReference":"2a34d64d-5185-474a-83d1-b0d9f7de6389","serviceType":"sample string 2","status":"sample string 3"}]}}
application/xml, text/xml
Sample:
<ChangeStatusTasksAndServicesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServicePlatform.BL.Models.BanzaiServicePlatform.Dto"> <AppointmentId>1</AppointmentId> <Assignment> <AssignedEngineers>sample string 1</AssignedEngineers> </Assignment> <Task> <CallID>sample string 1</CallID> <Comment>sample string 2</Comment> <CustomVersion>3</CustomVersion> <CustomVersionSpecified>true</CustomVersionSpecified> <EndWorkDate>sample string 5</EndWorkDate> <EngineerNote>sample string 6</EngineerNote> <Number>7</Number> <NumberSpecified>true</NumberSpecified> <RequiredServices> <RequiredService> <ExternalReference>2a34d64d-5185-474a-83d1-b0d9f7de6389</ExternalReference> <ServiceType>sample string 2</ServiceType> <Status>sample string 3</Status> </RequiredService> <RequiredService> <ExternalReference>2a34d64d-5185-474a-83d1-b0d9f7de6389</ExternalReference> <ServiceType>sample string 2</ServiceType> <Status>sample string 3</Status> </RequiredService> </RequiredServices> <Status> <Name>sample string 1</Name> </Status> </Task> </ChangeStatusTasksAndServicesRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
application/octet-stream
Sample:
{"AppointmentId":1,"Assignment":{"AssignedEngineers":"sample string 1"},"Task":{"CallID":"sample string 1","Comment":"sample string 2","CustomVersion":3,"CustomVersionSpecified":true,"EndWorkDate":"sample string 5","EngineerNote":"sample string 6","Number":7,"NumberSpecified":true,"Status":{"Name":"sample string 1"},"RequiredServices":[{"ExternalReference":"2a34d64d-5185-474a-83d1-b0d9f7de6389","ServiceType":"sample string 2","Status":"sample string 3"},{"ExternalReference":"2a34d64d-5185-474a-83d1-b0d9f7de6389","ServiceType":"sample string 2","Status":"sample string 3"}]}}
Response Information
Resource Description
Collection of ExceptionErrorDTOName | Description | Type | Additional information |
---|---|---|---|
StatusCode | string |
None. |
|
ErrorDescription | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "statusCode": "sample string 1", "errorDescription": "sample string 2" }, { "statusCode": "sample string 1", "errorDescription": "sample string 2" } ]
text/plain
Sample:
[{"statusCode":"sample string 1","errorDescription":"sample string 2"},{"statusCode":"sample string 1","errorDescription":"sample string 2"}]
application/xml, text/xml
Sample:
<ArrayOfExceptionErrorDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServicePlatform.BL.Errors"> <ExceptionErrorDTO> <ErrorDescription>sample string 2</ErrorDescription> <StatusCode>sample string 1</StatusCode> </ExceptionErrorDTO> <ExceptionErrorDTO> <ErrorDescription>sample string 2</ErrorDescription> <StatusCode>sample string 1</StatusCode> </ExceptionErrorDTO> </ArrayOfExceptionErrorDTO>
application/octet-stream
Sample:
[{"StatusCode":"sample string 1","ErrorDescription":"sample string 2"},{"StatusCode":"sample string 1","ErrorDescription":"sample string 2"}]
text/javascript, application/javascript, application/json-p
Sample:
([{"statusCode":"sample string 1","errorDescription":"sample string 2"},{"statusCode":"sample string 1","errorDescription":"sample string 2"}]);