WorkZone_9.8
GETGet Workzone
https://am-ce98c.corrigo.com/api/v1/base/Workzone/1
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
HEADERS
CompanyName
RDC CE Sandbox
Example Request
Get Workzone
curl
curl --location 'https://am-ce98c.corrigo.com/api/v1/base/Workzone/1' \
--header 'CompanyName: RDC CE Sandbox'200 OK
Example Response
json
{
"Data": {
"DisplayAs": "FL - FLOR (Orlando)",
"Asset": {
"Id": 1153
},
"TimeZone": 35,
"LanguageId": 1033,
"WoNumberPrefix": "ASN001",
"Entity": "Asurion",
"SchedulingWindow": 15,
"NoIncompleteProcedure": false,
"AccessOptionsMask": 8,
"Number": "FLOR",
"AdvanceNotice": 0,
"TaxRegion": {
"Id": 158470
},
"WoNumberDigits": 4,
"RoundApptTimeTo": 60,
"WorkPlanAutoCancel": false,
"WorkPlanChildResolution": false,
"WorkPlanAutoDependency": false,
"CpThemeId": 0,
"DefaultAccess": "NotApplicable",
"AutoAssignEnabled": false,
"BackupRoutingId": "Default",
"NoIncompleteItem": false,
"UiShowProvidersFirst": false,
"CurrencyTypeId": "USD",
"IsOffline": false,
"UseBizHours": true,
"UseHolidays": true,
"UseOnCall": true,
"UseEscalation": true,
"DefaultBillToLogic": 0,
"TurnKickOffAuto": false,
"TurnKickOffLagDays": 6,
"TurnKickOffOnDays": 62,
"EarliestSlot": 1,
"LatestSlot": 7,
"SlotsCount": 3,
"IsPrecalculatedSchedule": false,
"AllowTimePreference": false,
"TurnTemplateId": 0,
"IsmSpecGroupId": 0,
"IsmUrl": "",
"ExcludeNonCompliantProviders": "InheritGlobalSettings",
"IsNteAuto": true,
"IsRemoved": false,
"ConcurrencyId": 35,
"Id": 1
}
}Cache-Control
no-cache
Pragma
no-cache
Content-Type
application/json; charset=utf-8
Expires
-1
Date
Tue, 08 Mar 2022 07:11:39 GMT
Content-Length
1042
Strict-Transport-Security
max-age=31536000; includeSubDomains
POSTPost Workzone
https://am-ce98c.corrigo.com/api/v1/base/Workzone
AUTHORIZATIONOAuth 2.0
HEADERS
CompanyName
RDC CE Sandbox
Bodyraw (json)
json
{
"Entity": {
"DisplayAs": "0Corrigo Test",
"Asset": {
"Name": "",
"ModelId": 0,
"Orphan": false,
"TypeId": "Unknown",
"ParentId": 0,
"RootId": 0,
"IsTemplate": false,
"Documents": [],
"IsOffline": false,
"IsLocked": false,
"Attributes": [],
"Id": 194,
"PerformDeletion": false,
"IsNew": false
},
"TimeZone": 4,
"LanguageId": 1033,
"WoNumberPrefix": "TL",
"Entity": "Corrigo",
"SchedulingWindow": 120,
"NoIncompleteProcedure": false,
"AccessOptionsMask": 15,
"Number": "1234",
"AdvanceNotice": 24,
"TaxRegion": {
"Items": [],
"ConcurrencyId": 0,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
},
"WoNumberDigits": 4,
"RoundApptTimeTo": 60,
"WorkPlanAutoCancel": false,
"WorkPlanChildResolution": false,
"WorkPlanAutoDependency": false,
"CpThemeId": 2,
"DefaultAccess": "NotApplicable",
"AutoAssignEnabled": true,
"BackupRoutingId": "Default",
"NoIncompleteItem": false,
"UiShowProvidersFirst": true,
"CurrencyTypeId": "USD",
"IsOffline": false,
"ContactAddresses": [],
"CustomFields": [],
"Portfolios": [],
"SlaValues": [],
"Teams": [],
"BizHours": [],
"EscalationRules": [],
"SpecDispatchRules": [],
"OnCallRules": [],
"Responsibilities": [],
"UseBizHours": true,
"UseHolidays": true,
"UseOnCall": true,
"UseEscalation": true,
"DefaultBillToLogic": 1,
"TurnKickOffAuto": true,
"TurnKickOffLagDays": 10,
"TurnKickOffOnDays": 127,
"EarliestSlot": 1,
"LatestSlot": 7,
"SlotsCount": 3,
"IsPrecalculatedSchedule": false,
"AllowTimePreference": false,
"TurnTemplateId": 0,
"IsmSpecGroupId": 0,
"IsmUrl": "",
"ExcludeNonCompliantProviders": "InheritGlobalSettings",
"IsNteAuto": true,
"IsRemoved": false,
"ConcurrencyId": 62,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
}
}Example Request
Post Workzone
curl
curl --location 'https://am-ce98c.corrigo.com/api/v1/base/Workzone' \
--header 'CompanyName: RDC CE Sandbox' \
--data '{
"Entity": {
"DisplayAs": "0Corrigo Test",
"Asset": {
"Name": "",
"ModelId": 0,
"Orphan": false,
"TypeId": "Unknown",
"ParentId": 0,
"RootId": 0,
"IsTemplate": false,
"Documents": [],
"IsOffline": false,
"IsLocked": false,
"Attributes": [],
"Id": 194,
"PerformDeletion": false,
"IsNew": false
},
"TimeZone": 4,
"LanguageId": 1033,
"WoNumberPrefix": "TL",
"Entity": "Corrigo",
"SchedulingWindow": 120,
"NoIncompleteProcedure": false,
"AccessOptionsMask": 15,
"Number": "1234",
"AdvanceNotice": 24,
"TaxRegion": {
"Items": [],
"ConcurrencyId": 0,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
},
"WoNumberDigits": 4,
"RoundApptTimeTo": 60,
"WorkPlanAutoCancel": false,
"WorkPlanChildResolution": false,
"WorkPlanAutoDependency": false,
"CpThemeId": 2,
"DefaultAccess": "NotApplicable",
"AutoAssignEnabled": true,
"BackupRoutingId": "Default",
"NoIncompleteItem": false,
"UiShowProvidersFirst": true,
"CurrencyTypeId": "USD",
"IsOffline": false,
"ContactAddresses": [],
"CustomFields": [],
"Portfolios": [],
"SlaValues": [],
"Teams": [],
"BizHours": [],
"EscalationRules": [],
"SpecDispatchRules": [],
"OnCallRules": [],
"Responsibilities": [],
"UseBizHours": true,
"UseHolidays": true,
"UseOnCall": true,
"UseEscalation": true,
"DefaultBillToLogic": 1,
"TurnKickOffAuto": true,
"TurnKickOffLagDays": 10,
"TurnKickOffOnDays": 127,
"EarliestSlot": 1,
"LatestSlot": 7,
"SlotsCount": 3,
"IsPrecalculatedSchedule": false,
"AllowTimePreference": false,
"TurnTemplateId": 0,
"IsmSpecGroupId": 0,
"IsmUrl": "",
"ExcludeNonCompliantProviders": "InheritGlobalSettings",
"IsNteAuto": true,
"IsRemoved": false,
"ConcurrencyId": 62,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
}
}'400 Bad Request
Example Response
json
{
"ErrorMessage": "There are some custom command for 'WorkZone' for that action. Use '/cmd/WorkZone/Create' endpoint for that please.",
"ErrorCode": "CUSTOM_COMMAND_ERROR",
"TimeStamp": "2022-03-08T07:12:32.6474742Z"
}Cache-Control
no-cache
Pragma
no-cache
Content-Type
application/json; charset=utf-8
Expires
-1
Date
Tue, 08 Mar 2022 07:12:32 GMT
Content-Length
211
Strict-Transport-Security
max-age=31536000; includeSubDomains
PUTPut Workzone
https://am-ce98c.corrigo.com/api/v1/base/Workzone
AUTHORIZATIONOAuth 2.0
HEADERS
CompanyName
RDC CE Sandbox
Bodyraw (json)
json
{
"Properties" : ["*"] ,
"Entity": {
"DisplayAs": "FL - FLOR (Orlando)",
"Asset": {
"Name": "",
"ModelId": 0,
"Orphan": false,
"TypeId": "Unknown",
"ParentId": 0,
"RootId": 0,
"IsTemplate": false,
"Documents": [],
"IsOffline": false,
"IsLocked": false,
"Attributes": [],
"Id": 1153,
"PerformDeletion": false,
"IsNew": false
},
"TimeZone": 35,
"LanguageId": 1033,
"WoNumberPrefix": "ASN001",
"Entity": "Asurion",
"SchedulingWindow": 15,
"NoIncompleteProcedure": false,
"AccessOptionsMask": 8,
"Number": "FLOR",
"AdvanceNotice": 0,
"TaxRegion": {
"Items": [],
"ConcurrencyId": 0,
"Id": 158470,
"PerformDeletion": false,
"IsNew": false
},
"WoNumberDigits": 4,
"RoundApptTimeTo": 60,
"WorkPlanAutoCancel": false,
"WorkPlanChildResolution": false,
"WorkPlanAutoDependency": false,
"CpThemeId": 0,
"DefaultAccess": "NotApplicable",
"AutoAssignEnabled": false,
"BackupRoutingId": "Default",
"NoIncompleteItem": false,
"UiShowProvidersFirst": false,
"CurrencyTypeId": "USD",
"IsOffline": false,
"ContactAddresses": [],
"CustomFields": [],
"Portfolios": [],
"SlaValues": [],
"Teams": [],
"BizHours": [],
"EscalationRules": [],
"SpecDispatchRules": [],
"OnCallRules": [],
"Responsibilities": [],
"UseBizHours": true,
"UseHolidays": true,
"UseOnCall": true,
"UseEscalation": true,
"DefaultBillToLogic": 0,
"TurnKickOffAuto": false,
"TurnKickOffLagDays": 6,
"TurnKickOffOnDays": 62,
"EarliestSlot": 1,
"LatestSlot": 7,
"SlotsCount": 3,
"IsPrecalculatedSchedule": false,
"AllowTimePreference": false,
"TurnTemplateId": 0,
"IsmSpecGroupId": 0,
"IsmUrl": "",
"ExcludeNonCompliantProviders": "InheritGlobalSettings",
"IsNteAuto": true,
"IsRemoved": false,
"ConcurrencyId": 35,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
}
}Example Request
Put Workzone
curl
curl --location --request PUT 'https://am-ce98c.corrigo.com/api/v1/base/Workzone' \
--header 'CompanyName: RDC CE Sandbox' \
--data '{
"Properties" : ["*"] ,
"Entity": {
"DisplayAs": "FL - FLOR (Orlando)",
"Asset": {
"Name": "",
"ModelId": 0,
"Orphan": false,
"TypeId": "Unknown",
"ParentId": 0,
"RootId": 0,
"IsTemplate": false,
"Documents": [],
"IsOffline": false,
"IsLocked": false,
"Attributes": [],
"Id": 1153,
"PerformDeletion": false,
"IsNew": false
},
"TimeZone": 35,
"LanguageId": 1033,
"WoNumberPrefix": "ASN001",
"Entity": "Asurion",
"SchedulingWindow": 15,
"NoIncompleteProcedure": false,
"AccessOptionsMask": 8,
"Number": "FLOR",
"AdvanceNotice": 0,
"TaxRegion": {
"Items": [],
"ConcurrencyId": 0,
"Id": 158470,
"PerformDeletion": false,
"IsNew": false
},
"WoNumberDigits": 4,
"RoundApptTimeTo": 60,
"WorkPlanAutoCancel": false,
"WorkPlanChildResolution": false,
"WorkPlanAutoDependency": false,
"CpThemeId": 0,
"DefaultAccess": "NotApplicable",
"AutoAssignEnabled": false,
"BackupRoutingId": "Default",
"NoIncompleteItem": false,
"UiShowProvidersFirst": false,
"CurrencyTypeId": "USD",
"IsOffline": false,
"ContactAddresses": [],
"CustomFields": [],
"Portfolios": [],
"SlaValues": [],
"Teams": [],
"BizHours": [],
"EscalationRules": [],
"SpecDispatchRules": [],
"OnCallRules": [],
"Responsibilities": [],
"UseBizHours": true,
"UseHolidays": true,
"UseOnCall": true,
"UseEscalation": true,
"DefaultBillToLogic": 0,
"TurnKickOffAuto": false,
"TurnKickOffLagDays": 6,
"TurnKickOffOnDays": 62,
"EarliestSlot": 1,
"LatestSlot": 7,
"SlotsCount": 3,
"IsPrecalculatedSchedule": false,
"AllowTimePreference": false,
"TurnTemplateId": 0,
"IsmSpecGroupId": 0,
"IsmUrl": "",
"ExcludeNonCompliantProviders": "InheritGlobalSettings",
"IsNteAuto": true,
"IsRemoved": false,
"ConcurrencyId": 35,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
}
}'200 OK
Example Response
json
{
"EntitySpecifier": {
"ConcurrencyId": 35,
"EntityType": "WorkZone",
"Id": 1
}
}Cache-Control
no-cache
Pragma
no-cache
Content-Type
application/json; charset=utf-8
Expires
-1
Date
Tue, 08 Mar 2022 07:13:00 GMT
Content-Length
71
Strict-Transport-Security
max-age=31536000; includeSubDomains