POST {lang}/Units/UpsertType/{format}/{interfaceid}/{orgid}

Creates a new unit type or updates an existing unit type. UnitTypeId - as a response to unit creation you will receive "UnitTypeId" parameter. in order to update an unitType you will need to provide this parameter in the update request

Request Information

URI Parameters

Name	Type	Additional information
format	string	Required
interfaceid	integer	Required
orgid	integer	Required
lang	string	None.

Body Parameters

UnitTypeUpsertRequest

Name	Type	Additional information
UnitType	UnitType	None.
OrganizationID	integer	None.
UpdatePolicy	UpdatePolicy	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:

{
  "UpdatePolicy": 0,
  "UnitType": {
    "OrganizationID": 1,
    "UnitTypeID": 1,
    "UnitTypeName": "sample string 2",
    "MaxCapacity": 3,
    "IconCodeId": 4,
    "UnitTypeIconUrl": "https://img.nowforce.com/lb/4.jpg",
    "IsMedia": true,
    "Equipments": [
      {
        "EquipmentId": 3,
        "EquipmentName": "sample string 4",
        "IconCodeId": 5,
        "UnitTypeIconUrl": "https://img.nowforce.com/lb/5.jpg",
        "Minimum": 6,
        "Maximum": 7
      },
      {
        "EquipmentId": 3,
        "EquipmentName": "sample string 4",
        "IconCodeId": 5,
        "UnitTypeIconUrl": "https://img.nowforce.com/lb/5.jpg",
        "Minimum": 6,
        "Maximum": 7
      }
    ],
    "Members": [
      {
        "ObjectType": 1,
        "ObjectId": 3,
        "ObjectName": "sample string 4",
        "IconCodeId": 5,
        "IconUrl": "https://img.nowforce.com/lb/5.jpg",
        "Minimum": 6,
        "Maximum": 7,
        "Policy": 1
      },
      {
        "ObjectType": 1,
        "ObjectId": 3,
        "ObjectName": "sample string 4",
        "IconCodeId": 5,
        "IconUrl": "https://img.nowforce.com/lb/5.jpg",
        "Minimum": 6,
        "Maximum": 7,
        "Policy": 1
      }
    ],
    "MembersAccumulateMinCapacity": 12,
    "MembersAccumulateMaxCapacity": 14,
    "DynamicStatuses": [
      {
        "UnitTypeID": 2,
        "UnitTypeName": "sample string 3",
        "DynamicStatusId": 4,
        "DynamicStatusName": "sample string 5",
        "IsActive": true,
        "IconCodeId": 7,
        "IconUrl": "https://img.nowforce.com/lb/7.jpg"
      },
      {
        "UnitTypeID": 2,
        "UnitTypeName": "sample string 3",
        "DynamicStatusId": 4,
        "DynamicStatusName": "sample string 5",
        "IsActive": true,
        "IconCodeId": 7,
        "IconUrl": "https://img.nowforce.com/lb/7.jpg"
      }
    ]
  },
  "OrganizationID": 1
}

application/xml; charset=utf-8, application/xml

Sample:

<UnitTypeUpsertRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UpdatePolicy>FullUpdate</UpdatePolicy>
  <UnitType>
    <OrganizationID>1</OrganizationID>
    <UnitTypeID>1</UnitTypeID>
    <UnitTypeName>sample string 2</UnitTypeName>
    <MaxCapacity>3</MaxCapacity>
    <IconCodeId>4</IconCodeId>
    <IsMedia>true</IsMedia>
    <Equipments>
      <UnitTypeEquipment>
        <EquipmentId>3</EquipmentId>
        <EquipmentName>sample string 4</EquipmentName>
        <IconCodeId>5</IconCodeId>
        <Minimum>6</Minimum>
        <Maximum>7</Maximum>
      </UnitTypeEquipment>
      <UnitTypeEquipment>
        <EquipmentId>3</EquipmentId>
        <EquipmentName>sample string 4</EquipmentName>
        <IconCodeId>5</IconCodeId>
        <Minimum>6</Minimum>
        <Maximum>7</Maximum>
      </UnitTypeEquipment>
    </Equipments>
    <Members>
      <UnitTypeMember>
        <ObjectType>Title</ObjectType>
        <ObjectId>3</ObjectId>
        <ObjectName>sample string 4</ObjectName>
        <IconCodeId>5</IconCodeId>
        <Minimum>6</Minimum>
        <Maximum>7</Maximum>
      </UnitTypeMember>
      <UnitTypeMember>
        <ObjectType>Title</ObjectType>
        <ObjectId>3</ObjectId>
        <ObjectName>sample string 4</ObjectName>
        <IconCodeId>5</IconCodeId>
        <Minimum>6</Minimum>
        <Maximum>7</Maximum>
      </UnitTypeMember>
    </Members>
    <DynamicStatuses>
      <UnitTypeDynamicStatus>
        <UnitTypeID>2</UnitTypeID>
        <UnitTypeName>sample string 3</UnitTypeName>
        <DynamicStatusId>4</DynamicStatusId>
        <DynamicStatusName>sample string 5</DynamicStatusName>
        <IsActive>true</IsActive>
        <IconCodeId>7</IconCodeId>
      </UnitTypeDynamicStatus>
      <UnitTypeDynamicStatus>
        <UnitTypeID>2</UnitTypeID>
        <UnitTypeName>sample string 3</UnitTypeName>
        <DynamicStatusId>4</DynamicStatusId>
        <DynamicStatusName>sample string 5</DynamicStatusName>
        <IsActive>true</IsActive>
        <IconCodeId>7</IconCodeId>
      </UnitTypeDynamicStatus>
    </DynamicStatuses>
  </UnitType>
  <OrganizationID>1</OrganizationID>
</UnitTypeUpsertRequest>

Response Information

Resource Description

UnitTypeUpsertResponse

Name	Type	Additional information
UnitType	UnitType	None.
Result	boolean	None.
Error	UnitTypeUpsertError	None.
ErrorDesc	string	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:

{
  "UnitType": {
    "OrganizationID": 1,
    "UnitTypeID": 1,
    "UnitTypeName": "sample string 2",
    "MaxCapacity": 3,
    "IconCodeId": 4,
    "UnitTypeIconUrl": "https://img.nowforce.com/lb/4.jpg",
    "IsMedia": true,
    "Equipments": [
      {
        "EquipmentId": 3,
        "EquipmentName": "sample string 4",
        "IconCodeId": 5,
        "UnitTypeIconUrl": "https://img.nowforce.com/lb/5.jpg",
        "Minimum": 6,
        "Maximum": 7
      },
      {
        "EquipmentId": 3,
        "EquipmentName": "sample string 4",
        "IconCodeId": 5,
        "UnitTypeIconUrl": "https://img.nowforce.com/lb/5.jpg",
        "Minimum": 6,
        "Maximum": 7
      }
    ],
    "Members": [
      {
        "ObjectType": 1,
        "ObjectId": 3,
        "ObjectName": "sample string 4",
        "IconCodeId": 5,
        "IconUrl": "https://img.nowforce.com/lb/5.jpg",
        "Minimum": 6,
        "Maximum": 7,
        "Policy": 1
      },
      {
        "ObjectType": 1,
        "ObjectId": 3,
        "ObjectName": "sample string 4",
        "IconCodeId": 5,
        "IconUrl": "https://img.nowforce.com/lb/5.jpg",
        "Minimum": 6,
        "Maximum": 7,
        "Policy": 1
      }
    ],
    "MembersAccumulateMinCapacity": 12,
    "MembersAccumulateMaxCapacity": 14,
    "DynamicStatuses": [
      {
        "UnitTypeID": 2,
        "UnitTypeName": "sample string 3",
        "DynamicStatusId": 4,
        "DynamicStatusName": "sample string 5",
        "IsActive": true,
        "IconCodeId": 7,
        "IconUrl": "https://img.nowforce.com/lb/7.jpg"
      },
      {
        "UnitTypeID": 2,
        "UnitTypeName": "sample string 3",
        "DynamicStatusId": 4,
        "DynamicStatusName": "sample string 5",
        "IsActive": true,
        "IconCodeId": 7,
        "IconUrl": "https://img.nowforce.com/lb/7.jpg"
      }
    ]
  },
  "Result": true,
  "Error": 0,
  "ErrorDesc": "sample string 2"
}

application/xml; charset=utf-8, application/xml

Sample:

<UnitTypeUpsertResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UnitType>
    <OrganizationID>1</OrganizationID>
    <UnitTypeID>1</UnitTypeID>
    <UnitTypeName>sample string 2</UnitTypeName>
    <MaxCapacity>3</MaxCapacity>
    <IconCodeId>4</IconCodeId>
    <IsMedia>true</IsMedia>
    <Equipments>
      <UnitTypeEquipment>
        <EquipmentId>3</EquipmentId>
        <EquipmentName>sample string 4</EquipmentName>
        <IconCodeId>5</IconCodeId>
        <Minimum>6</Minimum>
        <Maximum>7</Maximum>
      </UnitTypeEquipment>
      <UnitTypeEquipment>
        <EquipmentId>3</EquipmentId>
        <EquipmentName>sample string 4</EquipmentName>
        <IconCodeId>5</IconCodeId>
        <Minimum>6</Minimum>
        <Maximum>7</Maximum>
      </UnitTypeEquipment>
    </Equipments>
    <Members>
      <UnitTypeMember>
        <ObjectType>Title</ObjectType>
        <ObjectId>3</ObjectId>
        <ObjectName>sample string 4</ObjectName>
        <IconCodeId>5</IconCodeId>
        <Minimum>6</Minimum>
        <Maximum>7</Maximum>
      </UnitTypeMember>
      <UnitTypeMember>
        <ObjectType>Title</ObjectType>
        <ObjectId>3</ObjectId>
        <ObjectName>sample string 4</ObjectName>
        <IconCodeId>5</IconCodeId>
        <Minimum>6</Minimum>
        <Maximum>7</Maximum>
      </UnitTypeMember>
    </Members>
    <DynamicStatuses>
      <UnitTypeDynamicStatus>
        <UnitTypeID>2</UnitTypeID>
        <UnitTypeName>sample string 3</UnitTypeName>
        <DynamicStatusId>4</DynamicStatusId>
        <DynamicStatusName>sample string 5</DynamicStatusName>
        <IsActive>true</IsActive>
        <IconCodeId>7</IconCodeId>
      </UnitTypeDynamicStatus>
      <UnitTypeDynamicStatus>
        <UnitTypeID>2</UnitTypeID>
        <UnitTypeName>sample string 3</UnitTypeName>
        <DynamicStatusId>4</DynamicStatusId>
        <DynamicStatusName>sample string 5</DynamicStatusName>
        <IsActive>true</IsActive>
        <IconCodeId>7</IconCodeId>
      </UnitTypeDynamicStatus>
    </DynamicStatuses>
  </UnitType>
  <Result>true</Result>
  <Error>None</Error>
  <ErrorDesc>sample string 2</ErrorDesc>
</UnitTypeUpsertResponse>