POST api/v1/banzaifieldservices/{PartnerId}/Appointment/ChangeActivityStatus
Change the activity status in ClickSoftware
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PartnerId |
The partner identifier: 1 = 'ePRICE' |
integer |
Required |
Body Parameters
Collection of ChangeActivityStatusRequestName | Description | Type | Additional information |
---|---|---|---|
ExternalReferenceNumber | globally unique identifier |
None. |
|
Key | integer |
None. |
|
Status | string |
None. |
|
ReasonCode | string |
None. |
|
FollowUpAction | string |
None. |
|
OldStatus | string |
None. |
|
NewActivityRuleId | integer |
None. |
|
ServiceCode | string |
None. |
|
ActivityCode | string |
None. |
Request Formats
application/json, text/json
Sample:
[ { "externalReferenceNumber": "0de5ea25-4c88-44bb-9340-8dd852bf6db2", "key": 2, "status": "sample string 3", "reasonCode": "sample string 4", "followUpAction": "sample string 5", "oldStatus": "sample string 6", "newActivityRuleId": 7, "serviceCode": "sample string 8", "activityCode": "sample string 9" }, { "externalReferenceNumber": "0de5ea25-4c88-44bb-9340-8dd852bf6db2", "key": 2, "status": "sample string 3", "reasonCode": "sample string 4", "followUpAction": "sample string 5", "oldStatus": "sample string 6", "newActivityRuleId": 7, "serviceCode": "sample string 8", "activityCode": "sample string 9" } ]
text/plain
Sample:
[{"externalReferenceNumber":"0de5ea25-4c88-44bb-9340-8dd852bf6db2","key":2,"status":"sample string 3","reasonCode":"sample string 4","followUpAction":"sample string 5","oldStatus":"sample string 6","newActivityRuleId":7,"serviceCode":"sample string 8","activityCode":"sample string 9"},{"externalReferenceNumber":"0de5ea25-4c88-44bb-9340-8dd852bf6db2","key":2,"status":"sample string 3","reasonCode":"sample string 4","followUpAction":"sample string 5","oldStatus":"sample string 6","newActivityRuleId":7,"serviceCode":"sample string 8","activityCode":"sample string 9"}]
application/xml, text/xml
Sample:
<ArrayOfChangeActivityStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServicePlatform.BL.Models.BanzaiServicePlatform.Dto"> <ChangeActivityStatusRequest> <ActivityCode>sample string 9</ActivityCode> <ExternalReferenceNumber>0de5ea25-4c88-44bb-9340-8dd852bf6db2</ExternalReferenceNumber> <FollowUpAction>sample string 5</FollowUpAction> <Key>2</Key> <NewActivityRuleId>7</NewActivityRuleId> <OldStatus>sample string 6</OldStatus> <ReasonCode>sample string 4</ReasonCode> <ServiceCode>sample string 8</ServiceCode> <Status>sample string 3</Status> </ChangeActivityStatusRequest> <ChangeActivityStatusRequest> <ActivityCode>sample string 9</ActivityCode> <ExternalReferenceNumber>0de5ea25-4c88-44bb-9340-8dd852bf6db2</ExternalReferenceNumber> <FollowUpAction>sample string 5</FollowUpAction> <Key>2</Key> <NewActivityRuleId>7</NewActivityRuleId> <OldStatus>sample string 6</OldStatus> <ReasonCode>sample string 4</ReasonCode> <ServiceCode>sample string 8</ServiceCode> <Status>sample string 3</Status> </ChangeActivityStatusRequest> </ArrayOfChangeActivityStatusRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
application/octet-stream
Sample:
[{"ExternalReferenceNumber":"0de5ea25-4c88-44bb-9340-8dd852bf6db2","Key":2,"Status":"sample string 3","ReasonCode":"sample string 4","FollowUpAction":"sample string 5","OldStatus":"sample string 6","NewActivityRuleId":7,"ServiceCode":"sample string 8","ActivityCode":"sample string 9"},{"ExternalReferenceNumber":"0de5ea25-4c88-44bb-9340-8dd852bf6db2","Key":2,"Status":"sample string 3","ReasonCode":"sample string 4","FollowUpAction":"sample string 5","OldStatus":"sample string 6","NewActivityRuleId":7,"ServiceCode":"sample string 8","ActivityCode":"sample string 9"}]
Response Information
Resource Description
Collection of ChangeActivityStatusResponseName | Description | Type | Additional information |
---|---|---|---|
Key | integer |
None. |
|
StatusCode | string |
None. |
|
ErrorDescription | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "key": 1, "statusCode": "sample string 2", "errorDescription": "sample string 3" }, { "key": 1, "statusCode": "sample string 2", "errorDescription": "sample string 3" } ]
text/plain
Sample:
[{"key":1,"statusCode":"sample string 2","errorDescription":"sample string 3"},{"key":1,"statusCode":"sample string 2","errorDescription":"sample string 3"}]
application/xml, text/xml
Sample:
<ArrayOfChangeActivityStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServicePlatform.BL.Models.BanzaiServicePlatform.Dto"> <ChangeActivityStatusResponse> <ErrorDescription>sample string 3</ErrorDescription> <Key>1</Key> <StatusCode>sample string 2</StatusCode> </ChangeActivityStatusResponse> <ChangeActivityStatusResponse> <ErrorDescription>sample string 3</ErrorDescription> <Key>1</Key> <StatusCode>sample string 2</StatusCode> </ChangeActivityStatusResponse> </ArrayOfChangeActivityStatusResponse>
application/octet-stream
Sample:
[{"Key":1,"StatusCode":"sample string 2","ErrorDescription":"sample string 3"},{"Key":1,"StatusCode":"sample string 2","ErrorDescription":"sample string 3"}]
text/javascript, application/javascript, application/json-p
Sample:
([{"key":1,"statusCode":"sample string 2","errorDescription":"sample string 3"},{"key":1,"statusCode":"sample string 2","errorDescription":"sample string 3"}]);