Jump to

• Request
• Response

View Offices for a specified name

get

/api/restapi/office/name/{officeName}

Send a request to this endpoint to view all offices having specified office name.

Request

Path Parameters

• officeName(required): string
  Name of the Offices to be found.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityOffice>

Type: array

Title: List<ApiEntityOffice>

Show Source

• Array of: object ApiEntityOffice
  Title: ApiEntityOffice

{
    "title":"List<ApiEntityOffice>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityOffice",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityOffice

Type: object

Title: ApiEntityOffice

Show Source

• addressLine1: string
  Maximum Length: 200

  The first line of the address of a location.
  This might be the building number and street address.
• addressLine2: string
  Maximum Length: 200

  The second line of the address of a location.
  This might be a neighborhood or town.
• cityName: string
  Maximum Length: 200

  The name of the city for a location.
• companyId: integer (int64)
  The unique identifier for the company.The company object can also be identified by its unique criteria.
• companyName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the company.
• countryCode: string
  Minimum Length: 0

  Maximum Length: 3

  The country for a location.
• distance: number (double)
  The distance the company is willing to travel for the project from this office.
• distanceMetric: string
  Allowed Values: [ "KILOMETERS", "MILES" ]

  The distance measure to be used. Valid options include kilometer and mile.
• fax: string
  Maximum Length: 32

  The fax number for the office.
• isCorporateOffice: boolean
  Indicates if the office is the headquarters of the company.
• latitude: number (double)
  Minimum Value: -90

  Maximum Value: 90

  The geographical coordinate for the latitude of the location.
  The default format for latitude is decimal degrees, but the format you need to use will depend on your geolocation service.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• longitude: number (double)
  Minimum Value: -180

  Maximum Value: 180

  The geographical coordinate for the longitude of the location.
  The default format for longitude is decimal degrees, but the format you need to use will depend on your geolocation service.
• officeCountryCode: string
  Minimum Length: 0

  Maximum Length: 200

  The country for a location.
• officeId: integer (int64)
  The unique identifier of an office.
• officeName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the office.
• officePostalCode: string
  Minimum Length: 0

  Maximum Length: 200

  The postal code, post code, or zip code of a location.
• orgOfficeId: integer (int64)
  The unique identifier of the organization of the office.
• phone: string
  Maximum Length: 32

  The phone number for the office.
• postalCode: string
  Minimum Length: 0

  Maximum Length: 20

  The postal code, post code, or zip code of a location.
• stateName: string
  Maximum Length: 200

  The state, region, or province of a location.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityOffice",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "officeName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the office.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "isCorporateOffice":{
            "type":"boolean",
            "description":"Indicates if the office is the headquarters of the company.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "orgOfficeId":{
            "type":"integer",
            "description":"The unique identifier of the organization of the office.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "longitude":{
            "maximum":180,
            "minimum":-180,
            "type":"number",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees, but the format you need to use will depend on your geolocation service.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "latitude":{
            "maximum":90,
            "minimum":-90,
            "type":"number",
            "description":"The geographical coordinate for the latitude of the location. <br />The default format for latitude is decimal degrees, but the format you need to use will depend on your geolocation service.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "companyName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":20,
            "minLength":0,
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "countryCode":{
            "maxLength":3,
            "minLength":0,
            "type":"string",
            "description":"The country for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "distance":{
            "type":"number",
            "description":"The distance the company is willing to travel for the project from this office.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "distanceMetric":{
            "type":"string",
            "description":"The distance measure to be used. Valid options include kilometer and mile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "KILOMETERS",
                "MILES"
            ]
        },
        "officeId":{
            "type":"integer",
            "description":"The unique identifier of an office.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The unique identifier for the company.The company object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "addressLine1":{
            "maxLength":200,
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine2":{
            "maxLength":200,
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cityName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the city for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "stateName":{
            "maxLength":200,
            "type":"string",
            "description":"The state, region, or province of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "officeCountryCode":{
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"The country for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "officePostalCode":{
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fax":{
            "maxLength":32,
            "type":"string",
            "description":"The fax number for the office.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "phone":{
            "maxLength":32,
            "type":"string",
            "description":"The phone number for the office.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested object does not exist, or you do not have access to it.

Back to Top