Show Source

• [0]: object ApiEntityOffice

{
    "title":"List<ApiEntityOffice>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityOffice"
    }
}

Show Source

• addressLine1(optional): string
  The first line of the address of a location.
  This might be the building number and street address.
• addressLine2(optional): string
  The second line of the address of a location.
  This might be a neighborhood or town.
• cityName(optional): string
  The city name for a location.
• companyId: integer(int64)
  The unique identifier of a company of an office.
• companyName(optional): string
  Allowed Values: [ "Length[1-255]" ]

  The name of the company.
• countryCode(optional): string
  The country for a location.
• fax(optional): string
  The fax number for the office.
• isCorporateOffice(optional): boolean
  If the office is the Head office of the company.
• latitude(optional): number(double)
  The geographical coordinate for the latitude of the location.
  The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• link(optional): string(url)
  Read Only: true
• longitude(optional): number(double)
  The geographical coordinate for the longitude of the location.
  The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• officeCountryCode: string
  The country for a location.
• officeId(optional): integer(int64)
  The unique identifier of an office.
• officeName: string
  Allowed Values: [ "Length[1-255]" ]

  The name of the office.
• officePostalCode: string
  The postal code, post code, or zip code of a location.
• orgOfficeId(optional): integer(int64)
  The unique identifier of the organization of the office.
• phone(optional): string
  The phone number for the office.
• postalCode(optional): string
  The postal code, post code, or zip code of a location.
• stateName(optional): string
  The state, region, or province of a location.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "companyId",
        "officeCountryCode",
        "officeName",
        "officePostalCode"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "officeName":{
            "type":"string",
            "description":"The name of the office.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "isCorporateOffice":{
            "type":"boolean",
            "description":"If the office is the Head office of the company."
        },
        "orgOfficeId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the organization of the office."
        },
        "longitude":{
            "type":"number",
            "format":"double",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service."
        },
        "latitude":{
            "type":"number",
            "format":"double",
            "description":"The geographical coordinate for the latitude of the location. <br />The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service."
        },
        "companyName":{
            "type":"string",
            "description":"The name of the company.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "postalCode":{
            "type":"string",
            "description":"The postal code, post code, or zip code of a location."
        },
        "countryCode":{
            "type":"string",
            "description":"The country for a location."
        },
        "addressLine1":{
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address."
        },
        "stateName":{
            "type":"string",
            "description":"The state, region, or province of a location."
        },
        "addressLine2":{
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town."
        },
        "cityName":{
            "type":"string",
            "description":"The city name for a location."
        },
        "phone":{
            "type":"string",
            "description":"The phone number for the office."
        },
        "officePostalCode":{
            "type":"string",
            "description":"The postal code, post code, or zip code of a location."
        },
        "officeCountryCode":{
            "type":"string",
            "description":"The country for a location."
        },
        "fax":{
            "type":"string",
            "description":"The fax number for the office."
        },
        "companyId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a company of an office."
        },
        "officeId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of an office."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}