Jump to

• Request
• Response

Add Locations

post

/config/sim/v1/hierarchy/location

Add Location object to a specified hierarchy unit of specified organization.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef(optional): string(string)
  Detail that Identifies that who made the change
• Simphony-OrgShortName: string(string)
  Org Identifier

Body ()

Location object of the organization

Root Schema : Location

Type: object

Model for Location Object

Show Source

• address1(optional): string
  The address line 1 for the property.

  Example: Address Line 1
• address2(optional): string
  The address line 2 for the property.

  Example: Address Line 2
• address3(optional): string
  The address line 3 for the property.

  Example: 1
• city(optional): string
  The city for the property

  Example: City
• comment(optional): string
  Additional information about the property.

  Example: Comment
• consumerFacingName(optional): object consumerFacingName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the consumer facing name in the configured languages
• country(optional): string
  The country for the property.

  Example: United States
• hierUnitId(optional): integer
  Unique reference of the hierarchy unit of the property

  Example: 2
• latitude(optional): string
  The property latitude. Latitude must be within range -90 to +90

  Example: 12.23
• localeInfoId(optional): integer
  Unique reference of the locale for the property to determine the use of decimal or thousand separators.

  Example: 1
• localeName(optional): object localeName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the locale for the property to determine the use of decimal or thousand separators in configured languages.
• longitude(optional): string
  The property longitude. Longitude must be between -180 and 180

  Example: 12.34
• name: object name
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• objectNum: integer
  Object number of the hierarchy unit

  Example: 1
• phone(optional): string
  The phone number of the property

  Example: 1234567890
• stateOrRegion(optional): string
  The state or region for the property.

  Example: Region
• tZIndex: integer
  The index time zone of the property.

  Example: 20
• tzName(optional): string
  The name time zone of the property.

  Example: (GMT-06:00) Central Time (US and Canada)
• zipOrPostalCode(optional): string
  The state or region for the property. The ZIP or postal code for the property.

  Example: YXA123

{
    "description":"Model for Location Object",
    "type":"object",
    "required":[
        "objectNum",
        "name",
        "tZIndex"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit of the property",
            "type":"integer",
            "example":2
        },
        "objectNum":{
            "description":"Object number of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"A group of string objects representing the name of the hierarchy unit configured languages",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "es-SS":"Empresa",
                "lt=LT":"??mon??"
            },
            "additionalProperties":{
                "type":"string"
            }
        },
        "consumerFacingName":{
            "description":"A group of string objects representing the consumer facing name in the configured languages",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "es-SS":"Empresa",
                "lt=LT":"??mon??"
            },
            "additionalProperties":{
                "type":"string"
            }
        },
        "phone":{
            "description":"The phone number of the property",
            "type":"string",
            "example":1234567890
        },
        "address1":{
            "description":"The address line 1 for the property.",
            "type":"string",
            "example":"Address Line 1"
        },
        "address2":{
            "description":"The address line 2 for the property.",
            "type":"string",
            "example":"Address Line 2"
        },
        "address3":{
            "description":"The address line 3 for the property.",
            "type":"string",
            "example":1
        },
        "city":{
            "description":"The city for the property",
            "type":"string",
            "example":"City"
        },
        "stateOrRegion":{
            "description":"The state or region for the property.",
            "type":"string",
            "example":"Region"
        },
        "zipOrPostalCode":{
            "description":"The state or region for the property. The ZIP or postal code for the property.",
            "type":"string",
            "example":"YXA123"
        },
        "country":{
            "description":"The country for the property.",
            "type":"string",
            "example":"United States"
        },
        "latitude":{
            "description":"The property latitude. Latitude must be within range -90 to +90",
            "type":"string",
            "example":12.23
        },
        "longitude":{
            "description":"The property longitude. Longitude must be between -180 and 180",
            "type":"string",
            "example":12.34
        },
        "comment":{
            "description":"Additional information about the property.",
            "type":"string",
            "example":"Comment"
        },
        "tZIndex":{
            "description":"The index time zone of the property.",
            "type":"integer",
            "example":20
        },
        "tzName":{
            "description":"The name time zone of the property.",
            "type":"string",
            "example":"(GMT-06:00) Central Time (US and Canada)"
        },
        "localeInfoId":{
            "description":"Unique reference of the locale for the property to determine the use of decimal or thousand separators.",
            "type":"integer",
            "example":1
        },
        "localeName":{
            "description":"A group of string objects representing the name of the locale for the property to determine the use of decimal or thousand separators in configured languages.",
            "type":"object",
            "example":{
                "en-US":"Locale 1",
                "es-SS":"",
                "lt=LT":""
            },
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : consumerFacingName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the consumer facing name in the configured languages",
    "type":"object",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the consumer facing name in the configured languages

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : localeName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the locale for the property to determine the use of decimal or thousand separators in configured languages.",
    "type":"object",
    "example":{
        "en-US":"Locale 1",
        "es-SS":"",
        "lt=LT":""
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the locale for the property to determine the use of decimal or thousand separators in configured languages.

Example:

{
    "en-US":"Locale 1",
    "es-SS":"",
    "lt=LT":""
}

Nested Schema : name

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "type":"object",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Location object of the organization

Body ()

Root Schema : LocationResponse

Type: object

Show Source

• hierUnitId: integer
  unique hierarchy unit value

  Example: 1
• objectNum: integer
  Object number of the printer

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "description":"unique hierarchy unit value",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the printer",
            "type":"integer",
            "example":1
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top