HomeRecipesAPI ReferenceChangelogDiscussions
Log In
Discussions

Discussions

Ask a Question
Back to All

Actions List


For the Schedule action, we suspect below is the endpoint to be used. If not, which is the endpoint to use and pls provide with the request body.
curl --location 'https://am-ce98c.corrigo.com/api/v1/cmd/WoScheduleRoutine'
--header 'CompanyName: RDC CE Sandbox'
--data '{
"Command": {
"WorkOrderId": 1
},
"RequestId": "1234"
}
'
For the Send Message action, we found below endpoint to use from the forum to send message.
curl --location 'https://am-ce98c.corrigo.com/api/v1/cmd/WoMessageCommand'
--header 'CompanyName: RDC CE Sandbox'
--data '{
"Command": {
"WorkOrderId": 388143,
"SenderId": 1,
"SenderType": "Employee",
"Comment":"TestPerfect"
},
"RequestId": "1234"
}
'
https://developer.corrigo.com/discuss/677bb5ed7007a8007aa36b13
above is the ticket we raised for clarification.
Body:
{
"Command": {
"WorkOrderId": 83669,
"SenderId": 676,
"SenderType": "Employee",
"Comment":"Test
---_Perfect"
}
}
We’re getting the below error if we use the above body. We created a work order and in response we could see an Id, which we have used in WorkOrderId in the above request body but got the below response. Could you please help us to know why we are facing this issue.
Response:
{
"ErrorMessage": "Sorry, this command can be used only for Work Order sent to a connected Service Pro",
"ErrorCode": "BUSINESS_LOGIC_ERROR",
"TimeStamp": "2025-01-06T11:54:07.2454114Z"
}

For the View All Messages action, We need API details with the sample request body.
For the Cancel Request action, We Suspect below API endpoint need to be used,
curl --location 'https://am-ce98c.corrigo.com/api/v1/cmd/WoCancelCommand'
--header 'CompanyName: RDC CE Sandbox'
--data '{
"Command": {
"WorkOrderId": 388037,
"Comment": "Cancelled",
"ActionReasonId":1796
},
"RequestId": "12345"
}'
curl --location 'https://am-ce98c.corrigo.com/api/v1/cmd/WoCancelCommand'
--header 'CompanyName: RDC CE Sandbox'
--data '{
"Command": {
"WorkOrderId": 109
},
"RequestId": "1234"
}
'
In the above two samples, Which one is an appropriate one to be used? Also, what is the ActionReasonId to be given in request body? Where can we get that from?

For the Verify action, what are the values we can use for WoRatingId?
curl --location 'https://am-ce98c.corrigo.com/api/v1/cmd/VerifyWorkCommand'
--header 'CompanyName: RDC CE Sandbox'
--data '{
"Command": {
"WorkOrderId": 150,
"WoRatingId":"Positive",
"Comment":"Good Service"
},
"RequestId": "1234"
}
'.
For the Add Note action, We suspect the below endpoint to be used. We need details of request body properties:

  • NoteTypeId(API endpoint to get all the NoteTypeId values, also need a clarification on which to use when)
  • For ActorId, do we need to use contactId or assignee Id? Also need to know what we can pass for ActorTypeId.
  • CreatedAt is the time of wo creation or note sending time?
  • CreatedBy Id is of assignee Id or ContactId?
  • "PerformDeletion": false, "IsNew": false – are these two constant values to use as false? If not how to use it?
  • What is the Id we need to pass at the end?
    curl --location 'https://am-ce98c.corrigo.com//api/v1/base/Note'
    --header 'CompanyName: RDC CE Sandbox'
    --data ' {
    "Entity":
    {
    "Body":"sample text",
    "WorkOrderId":14389,
    "NoteTypeId":2,
    "ActorId": 316,
    "ActorTypeId": "Org",
    "CreatedAt": "2011-03-31T11:52:07",
    "CreatedBy": {
    "Id": 538,
    "TypeId": "Employee",
    "PerformDeletion": false,
    "IsNew": false
    },
    "Id":0
    }
    }'