POST {lang}/Scenarios/UpsertPhase/{format}/{interfaceid}/{orgid}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| format | string |
Required |
|
| interfaceid | integer |
Required |
|
| orgid | integer |
Required |
|
| lang | string |
None. |
Body Parameters
ScenarioPhaseUpsertRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| OrganizationId | integer |
None. |
|
| ScenarioId | string |
Required |
|
| ScenarioPhase | ScenarioPhase |
Required |
|
| ShouldUpdateTasks | boolean |
None. |
Request Formats
application/json; charset=utf-8, application/json, application/vnd.google-earth.kml+xml, text/plain, image/png, text/csv, application/x-www-form-urlencoded
Sample:
{
"OrganizationId": 1,
"ScenarioId": "sample string 2",
"ScenarioPhase": {
"_id": "sample string 1",
"OrderId": 2,
"ParentId": "sample string 3",
"Title": "sample string 4",
"Tasks": [
{
"_id": "sample string 1",
"TaskName": "sample string 2",
"IncidentTypeId": 3,
"IncidentTypeName": "sample string 4",
"IncidentTypeIconUrl": "sample string 5",
"Location": {
"LocationType": 0,
"Address": "sample string 1",
"PoiId": 1,
"Lat": 1.1,
"Long": 1.1
},
"TimeAfterType": 0,
"TimeAfterBeginningOfScenario": 6.1,
"StartTime": "2025-10-26T19:01:52.5935166Z",
"DispatchType": 0,
"DispatchRules": [
{
"Name": "sample string 1",
"Amount": 2,
"IconUrl": "sample string 3"
},
{
"Name": "sample string 1",
"Amount": 2,
"IconUrl": "sample string 3"
}
],
"SLA": {
"Dispatch": 1,
"OnScene": 1,
"Done": 2
},
"TaskTimingType": 0,
"TaskTimingAtMinutes": 1,
"DispatchResponders": [
{
"Id": 1,
"Name": "sample string 2",
"Type": 3,
"PictureUrl": "sample string 4"
},
{
"Id": 1,
"Name": "sample string 2",
"Type": 3,
"PictureUrl": "sample string 4"
}
]
},
{
"_id": "sample string 1",
"TaskName": "sample string 2",
"IncidentTypeId": 3,
"IncidentTypeName": "sample string 4",
"IncidentTypeIconUrl": "sample string 5",
"Location": {
"LocationType": 0,
"Address": "sample string 1",
"PoiId": 1,
"Lat": 1.1,
"Long": 1.1
},
"TimeAfterType": 0,
"TimeAfterBeginningOfScenario": 6.1,
"StartTime": "2025-10-26T19:01:52.5935166Z",
"DispatchType": 0,
"DispatchRules": [
{
"Name": "sample string 1",
"Amount": 2,
"IconUrl": "sample string 3"
},
{
"Name": "sample string 1",
"Amount": 2,
"IconUrl": "sample string 3"
}
],
"SLA": {
"Dispatch": 1,
"OnScene": 1,
"Done": 2
},
"TaskTimingType": 0,
"TaskTimingAtMinutes": 1,
"DispatchResponders": [
{
"Id": 1,
"Name": "sample string 2",
"Type": 3,
"PictureUrl": "sample string 4"
},
{
"Id": 1,
"Name": "sample string 2",
"Type": 3,
"PictureUrl": "sample string 4"
}
]
}
],
"Start": "2025-10-26T19:01:52.5935166Z",
"End": "2025-10-26T19:01:52.5935166Z"
},
"ShouldUpdateTasks": true
}
application/xml; charset=utf-8, application/xml
Sample:
<ScenarioPhaseUpsertRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<OrganizationId>1</OrganizationId>
<ScenarioId>sample string 2</ScenarioId>
<ScenarioPhase>
<_id>sample string 1</_id>
<OrderId>2</OrderId>
<ParentId>sample string 3</ParentId>
<Title>sample string 4</Title>
<Tasks>
<PhaseTask>
<_id>sample string 1</_id>
<TaskName>sample string 2</TaskName>
<IncidentTypeId>3</IncidentTypeId>
<IncidentTypeName>sample string 4</IncidentTypeName>
<IncidentTypeIconUrl>sample string 5</IncidentTypeIconUrl>
<Location>
<LocationType>ScenarioLocation</LocationType>
<Address>sample string 1</Address>
<PoiId>1</PoiId>
<Lat>1.1</Lat>
<Long>1.1</Long>
</Location>
<TimeAfterType>Minutes</TimeAfterType>
<TimeAfterBeginningOfScenario>6.1</TimeAfterBeginningOfScenario>
<StartTime>2025-10-26T19:01:52.5935166+00:00</StartTime>
<DispatchType>Manual</DispatchType>
<DispatchRules>
<DispatchRule>
<Name>sample string 1</Name>
<Amount>2</Amount>
<IconUrl>sample string 3</IconUrl>
</DispatchRule>
<DispatchRule>
<Name>sample string 1</Name>
<Amount>2</Amount>
<IconUrl>sample string 3</IconUrl>
</DispatchRule>
</DispatchRules>
<SLA>
<Dispatch>1</Dispatch>
<OnScene>1</OnScene>
<Done>2</Done>
</SLA>
<TaskTimingType>At</TaskTimingType>
<TaskTimingAtMinutes>1</TaskTimingAtMinutes>
<DispatchResponders>
<TaskDispatchResponders>
<Id>1</Id>
<Name>sample string 2</Name>
<Type>3</Type>
<PictureUrl>sample string 4</PictureUrl>
</TaskDispatchResponders>
<TaskDispatchResponders>
<Id>1</Id>
<Name>sample string 2</Name>
<Type>3</Type>
<PictureUrl>sample string 4</PictureUrl>
</TaskDispatchResponders>
</DispatchResponders>
</PhaseTask>
<PhaseTask>
<_id>sample string 1</_id>
<TaskName>sample string 2</TaskName>
<IncidentTypeId>3</IncidentTypeId>
<IncidentTypeName>sample string 4</IncidentTypeName>
<IncidentTypeIconUrl>sample string 5</IncidentTypeIconUrl>
<Location>
<LocationType>ScenarioLocation</LocationType>
<Address>sample string 1</Address>
<PoiId>1</PoiId>
<Lat>1.1</Lat>
<Long>1.1</Long>
</Location>
<TimeAfterType>Minutes</TimeAfterType>
<TimeAfterBeginningOfScenario>6.1</TimeAfterBeginningOfScenario>
<StartTime>2025-10-26T19:01:52.5935166+00:00</StartTime>
<DispatchType>Manual</DispatchType>
<DispatchRules>
<DispatchRule>
<Name>sample string 1</Name>
<Amount>2</Amount>
<IconUrl>sample string 3</IconUrl>
</DispatchRule>
<DispatchRule>
<Name>sample string 1</Name>
<Amount>2</Amount>
<IconUrl>sample string 3</IconUrl>
</DispatchRule>
</DispatchRules>
<SLA>
<Dispatch>1</Dispatch>
<OnScene>1</OnScene>
<Done>2</Done>
</SLA>
<TaskTimingType>At</TaskTimingType>
<TaskTimingAtMinutes>1</TaskTimingAtMinutes>
<DispatchResponders>
<TaskDispatchResponders>
<Id>1</Id>
<Name>sample string 2</Name>
<Type>3</Type>
<PictureUrl>sample string 4</PictureUrl>
</TaskDispatchResponders>
<TaskDispatchResponders>
<Id>1</Id>
<Name>sample string 2</Name>
<Type>3</Type>
<PictureUrl>sample string 4</PictureUrl>
</TaskDispatchResponders>
</DispatchResponders>
</PhaseTask>
</Tasks>
<Start>2025-10-26T19:01:52.5935166+00:00</Start>
<End>2025-10-26T19:01:52.5935166+00:00</End>
</ScenarioPhase>
<ShouldUpdateTasks>true</ShouldUpdateTasks>
</ScenarioPhaseUpsertRequest>
Response Information
Resource Description
ScenarioPhaseUpsertResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | boolean |
None. |
|
| UpdatedPhase | ScenarioPhase |
None. |
|
| ErrorCode | ScenarioErrorType |
None. |
Response Formats
application/json; charset=utf-8, application/json, application/vnd.google-earth.kml+xml, text/plain, image/png, text/csv, application/x-www-form-urlencoded
Sample:
{
"Result": true,
"UpdatedPhase": {
"_id": "sample string 1",
"OrderId": 2,
"ParentId": "sample string 3",
"Title": "sample string 4",
"Tasks": [
{
"_id": "sample string 1",
"TaskName": "sample string 2",
"IncidentTypeId": 3,
"IncidentTypeName": "sample string 4",
"IncidentTypeIconUrl": "sample string 5",
"Location": {
"LocationType": 0,
"Address": "sample string 1",
"PoiId": 1,
"Lat": 1.1,
"Long": 1.1
},
"TimeAfterType": 0,
"TimeAfterBeginningOfScenario": 6.1,
"StartTime": "2025-10-26T19:01:53.2202036Z",
"DispatchType": 0,
"DispatchRules": [
{
"Name": "sample string 1",
"Amount": 2,
"IconUrl": "sample string 3"
},
{
"Name": "sample string 1",
"Amount": 2,
"IconUrl": "sample string 3"
}
],
"SLA": {
"Dispatch": 1,
"OnScene": 1,
"Done": 2
},
"TaskTimingType": 0,
"TaskTimingAtMinutes": 1,
"DispatchResponders": [
{
"Id": 1,
"Name": "sample string 2",
"Type": 3,
"PictureUrl": "sample string 4"
},
{
"Id": 1,
"Name": "sample string 2",
"Type": 3,
"PictureUrl": "sample string 4"
}
]
},
{
"_id": "sample string 1",
"TaskName": "sample string 2",
"IncidentTypeId": 3,
"IncidentTypeName": "sample string 4",
"IncidentTypeIconUrl": "sample string 5",
"Location": {
"LocationType": 0,
"Address": "sample string 1",
"PoiId": 1,
"Lat": 1.1,
"Long": 1.1
},
"TimeAfterType": 0,
"TimeAfterBeginningOfScenario": 6.1,
"StartTime": "2025-10-26T19:01:53.2202036Z",
"DispatchType": 0,
"DispatchRules": [
{
"Name": "sample string 1",
"Amount": 2,
"IconUrl": "sample string 3"
},
{
"Name": "sample string 1",
"Amount": 2,
"IconUrl": "sample string 3"
}
],
"SLA": {
"Dispatch": 1,
"OnScene": 1,
"Done": 2
},
"TaskTimingType": 0,
"TaskTimingAtMinutes": 1,
"DispatchResponders": [
{
"Id": 1,
"Name": "sample string 2",
"Type": 3,
"PictureUrl": "sample string 4"
},
{
"Id": 1,
"Name": "sample string 2",
"Type": 3,
"PictureUrl": "sample string 4"
}
]
}
],
"Start": "2025-10-26T19:01:53.2202036Z",
"End": "2025-10-26T19:01:53.2202036Z"
},
"ErrorCode": 0
}
application/xml; charset=utf-8, application/xml
Sample:
<ScenarioPhaseUpsertResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Result>true</Result>
<UpdatedPhase>
<_id>sample string 1</_id>
<OrderId>2</OrderId>
<ParentId>sample string 3</ParentId>
<Title>sample string 4</Title>
<Tasks>
<PhaseTask>
<_id>sample string 1</_id>
<TaskName>sample string 2</TaskName>
<IncidentTypeId>3</IncidentTypeId>
<IncidentTypeName>sample string 4</IncidentTypeName>
<IncidentTypeIconUrl>sample string 5</IncidentTypeIconUrl>
<Location>
<LocationType>ScenarioLocation</LocationType>
<Address>sample string 1</Address>
<PoiId>1</PoiId>
<Lat>1.1</Lat>
<Long>1.1</Long>
</Location>
<TimeAfterType>Minutes</TimeAfterType>
<TimeAfterBeginningOfScenario>6.1</TimeAfterBeginningOfScenario>
<StartTime>2025-10-26T19:01:53.2202036+00:00</StartTime>
<DispatchType>Manual</DispatchType>
<DispatchRules>
<DispatchRule>
<Name>sample string 1</Name>
<Amount>2</Amount>
<IconUrl>sample string 3</IconUrl>
</DispatchRule>
<DispatchRule>
<Name>sample string 1</Name>
<Amount>2</Amount>
<IconUrl>sample string 3</IconUrl>
</DispatchRule>
</DispatchRules>
<SLA>
<Dispatch>1</Dispatch>
<OnScene>1</OnScene>
<Done>2</Done>
</SLA>
<TaskTimingType>At</TaskTimingType>
<TaskTimingAtMinutes>1</TaskTimingAtMinutes>
<DispatchResponders>
<TaskDispatchResponders>
<Id>1</Id>
<Name>sample string 2</Name>
<Type>3</Type>
<PictureUrl>sample string 4</PictureUrl>
</TaskDispatchResponders>
<TaskDispatchResponders>
<Id>1</Id>
<Name>sample string 2</Name>
<Type>3</Type>
<PictureUrl>sample string 4</PictureUrl>
</TaskDispatchResponders>
</DispatchResponders>
</PhaseTask>
<PhaseTask>
<_id>sample string 1</_id>
<TaskName>sample string 2</TaskName>
<IncidentTypeId>3</IncidentTypeId>
<IncidentTypeName>sample string 4</IncidentTypeName>
<IncidentTypeIconUrl>sample string 5</IncidentTypeIconUrl>
<Location>
<LocationType>ScenarioLocation</LocationType>
<Address>sample string 1</Address>
<PoiId>1</PoiId>
<Lat>1.1</Lat>
<Long>1.1</Long>
</Location>
<TimeAfterType>Minutes</TimeAfterType>
<TimeAfterBeginningOfScenario>6.1</TimeAfterBeginningOfScenario>
<StartTime>2025-10-26T19:01:53.2202036+00:00</StartTime>
<DispatchType>Manual</DispatchType>
<DispatchRules>
<DispatchRule>
<Name>sample string 1</Name>
<Amount>2</Amount>
<IconUrl>sample string 3</IconUrl>
</DispatchRule>
<DispatchRule>
<Name>sample string 1</Name>
<Amount>2</Amount>
<IconUrl>sample string 3</IconUrl>
</DispatchRule>
</DispatchRules>
<SLA>
<Dispatch>1</Dispatch>
<OnScene>1</OnScene>
<Done>2</Done>
</SLA>
<TaskTimingType>At</TaskTimingType>
<TaskTimingAtMinutes>1</TaskTimingAtMinutes>
<DispatchResponders>
<TaskDispatchResponders>
<Id>1</Id>
<Name>sample string 2</Name>
<Type>3</Type>
<PictureUrl>sample string 4</PictureUrl>
</TaskDispatchResponders>
<TaskDispatchResponders>
<Id>1</Id>
<Name>sample string 2</Name>
<Type>3</Type>
<PictureUrl>sample string 4</PictureUrl>
</TaskDispatchResponders>
</DispatchResponders>
</PhaseTask>
</Tasks>
<Start>2025-10-26T19:01:53.2202036+00:00</Start>
<End>2025-10-26T19:01:53.2202036+00:00</End>
</UpdatedPhase>
<ErrorCode>None</ErrorCode>
</ScenarioPhaseUpsertResponse>