Jump to

• Request
• Response

Get a business location communication related attributes

get

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationCommunications/{BusinessLocationKey}

Request

Path Parameters

• BusinessLocationKey(required): integer(int64)
  The unique identifier for a business location.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorBusinessLocationCommunications-item-response

Type: object

Show Source

• Address1: string
  Title: Location Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the physical address.
• Address2: string
  Title: Location Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the physical address.
• BusinessAddress1: string
  Title: Business Address 1

  Read Only: true

  Maximum Length: 240

  The first line of the physical address of the business entity.
• BusinessAddress2: string
  Title: Business Address 2

  Read Only: true

  Maximum Length: 240

  The second line of the physical address of the business entity.
• BusinessCity: string
  Title: Business City

  Read Only: true

  Maximum Length: 60

  The physical address city of the business entity.
• BusinessCountry: string
  Title: Business Country

  Read Only: true

  Maximum Length: 3

  The physical country address of the business entity.
• BusinessEntityId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier for a business entity.
• BusinessEntityKey: integer (int64)
  Read Only: true

  The unique identifier for a business entity.
• BusinessLocationId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier for a business location.
• BusinessLocationKey: integer (int64)
  Read Only: true

  The unique identifier for a business location.
• BusinessPostalCode: string
  Title: Business Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code of physical address of the business entity.
• BusinessState: string
  Title: Business State

  Read Only: true

  Maximum Length: 60

  The physical address state of the business entity.
• BusinessStatus: string
  Title: Business Status

  Read Only: true

  Maximum Length: 10

  The current status of the business entity.
• BusOwnershipType: string
  Title: Ownership Type

  Read Only: true

  Maximum Length: 15

  The type of business ownership.
• City: string
  Title: Location City

  Read Only: true

  Maximum Length: 60

  The physical address of the city.
• Country: string
  Title: Location Country

  Read Only: true

  Maximum Length: 3

  The physical address of the country.
• DoingBusinessAs: string
  Title: Doing Business As

  Read Only: true

  Maximum Length: 100

  The doing business as name for a business entity.
• EarliestAboutToExpireDate: string (date-time)
  Title: Earliest License About to Expire

  Read Only: true

  The earliest about to expire date among all the licenses of a location.
• EarliestExpirationDate: string (date-time)
  Title: Earliest License Expiration Date

  Read Only: true

  The earliest license expiration date among all the licenses of a location.
• EarliestExpirationGraceDate: string (date-time)
  Title: Earliest License Grace Date

  Read Only: true

  The earliest license grace date among all the licenses of a location.
• EcontactEmailOne: string
  Title: Emergency Contact 1 Email

  Read Only: true

  Maximum Length: 320

  The email address of the primary emergency contact.
• EcontactEmailTwo: string
  Title: Emergency Contact 2 Email

  Read Only: true

  Maximum Length: 320

  The email address of the secondary emergency contact.
• EcontactFirstNameOne: string
  Title: Emergency Contact 1 First Name

  Read Only: true

  Maximum Length: 150

  The first name of the primary emergency contact.
• EcontactFirstNameTwo: string
  Title: Emergency Contact 2 First Name

  Read Only: true

  Maximum Length: 150

  The first name of the secondary emergency contact.
• EcontactLastNameOne: string
  Title: Emergency Contact 1 Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the primary emergency contact.
• EcontactLastNameTwo: string
  Title: Emergency Contact 2 Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the secondary emergency contact.
• EcontactOnePhoneNumber: string
  Title: Emergency Contact 1 Phone Number

  Read Only: true

  Maximum Length: 60

  The primary emergency contact phone number of the location.
• EcontactTwoPhoneNumber: string
  Title: Emergency Contact 2 Phone Number

  Read Only: true

  Maximum Length: 60

  The secondary emergency contact phone number of the location.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  Email address of the location.
• FeeDue: number
  Title: Fees Balance Due

  Read Only: true

  The sum of the total outstanding fee for all the licenses of a location.
• FeePaid: number
  Title: Fees Total Paid

  Read Only: true

  The sum of the total fee paid for all the licenses of a location.
• LegalName: string
  Title: Legal Name

  Read Only: true

  Maximum Length: 240

  The name of the business entity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationType: string
  Title: Location Type

  Read Only: true

  Maximum Length: 30

  The type of location.
• MailAddress1: string
  Title: Mailing Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the location mailing address.
• MailAddress2: string
  Title: Mailing Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the location mailing address.
• MailCity: string
  Title: Mailing City

  Read Only: true

  Maximum Length: 60

  The location of the mailing city.
• MailCountry: string
  Title: Mailing Address Country

  Read Only: true

  Maximum Length: 3

  The location of the mailing country.
• MailPostalCode: string
  Title: Mailing Postal Code

  Read Only: true

  Maximum Length: 60

  The location of the mailing postal code.
• MailState: string
  Title: Mailing State

  Read Only: true

  Maximum Length: 60

  The location of the mailing state.
• PostalCode: string
  Title: Location Postal Code

  Read Only: true

  Maximum Length: 60

  The physical address of the postal code.
• PrimaryPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  Maximum Length: 60

  The primary phone number of the location.
• State: string
  Title: Location State

  Read Only: true

  Maximum Length: 60

  The physical address of the state.
• Status: string
  Title: Location Status

  Read Only: true

  Maximum Length: 10

  The current status of the location.
• TotalFee: number
  Title: Fees Total Amount

  Read Only: true

  The sum of the total fee for all the licenses of a location.
• Url: string
  Title: URL

  Read Only: true

  Maximum Length: 255

  The URL of the business entity.

{
    "type":"object",
    "properties":{
        "EcontactEmailTwo":{
            "title":"Emergency Contact 2 Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the secondary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "MailCountry":{
            "title":"Mailing Address Country",
            "maxLength":"3",
            "type":"string",
            "description":"The location of the mailing country.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessCity":{
            "title":"Business City",
            "maxLength":"60",
            "type":"string",
            "description":"The physical address city of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for a business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DoingBusinessAs":{
            "title":"Doing Business As",
            "maxLength":"100",
            "type":"string",
            "description":"The doing business as name for a business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Location Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The physical address of the postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessCountry":{
            "title":"Business Country",
            "maxLength":"3",
            "type":"string",
            "description":"The physical country address of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessStatus":{
            "title":"Business Status",
            "maxLength":"10",
            "type":"string",
            "description":"The current status of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "maxLength":"255",
            "type":"string",
            "description":"The URL of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URL":"Y"
            },
            "x-queryable":true
        },
        "EcontactLastNameOne":{
            "title":"Emergency Contact 1 Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the primary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeePaid":{
            "title":"Fees Total Paid",
            "type":"number",
            "description":"The sum of the total fee paid for all the licenses of a location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "MailState":{
            "title":"Mailing State",
            "maxLength":"60",
            "type":"string",
            "description":"The location of the mailing state.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityKey":{
            "type":"integer",
            "description":"The unique identifier for a business entity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusinessState":{
            "title":"Business State",
            "maxLength":"60",
            "type":"string",
            "description":"The physical address state of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailCity":{
            "title":"Mailing City",
            "maxLength":"60",
            "type":"string",
            "description":"The location of the mailing city.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EcontactFirstNameTwo":{
            "title":"Emergency Contact 2 First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the secondary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeDue":{
            "title":"Fees Balance Due",
            "type":"number",
            "description":"The sum of the total outstanding fee for all the licenses of a location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Location Status",
            "maxLength":"10",
            "type":"string",
            "description":"The current status of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarliestExpirationGraceDate":{
            "title":"Earliest License Grace Date",
            "type":"string",
            "description":"The earliest license grace date among all the licenses of a location.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalName":{
            "title":"Legal Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusOwnershipType":{
            "title":"Ownership Type",
            "maxLength":"15",
            "type":"string",
            "description":"The type of business ownership.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactTwoPhoneNumber":{
            "title":"Emergency Contact 2 Phone Number",
            "maxLength":"60",
            "type":"string",
            "description":"The secondary emergency contact phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "BusinessPostalCode":{
            "title":"Business Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of physical address of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessLocationKey":{
            "type":"integer",
            "description":"The unique identifier for a business location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Location Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the physical address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"Location City",
            "maxLength":"60",
            "type":"string",
            "description":"The physical address of the city.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Location Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the physical address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailPostalCode":{
            "title":"Mailing Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The location of the mailing postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"Email address of the location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "EarliestAboutToExpireDate":{
            "title":"Earliest License About to Expire",
            "type":"string",
            "description":"The earliest about to expire date among all the licenses of a location.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactOnePhoneNumber":{
            "title":"Emergency Contact 1 Phone Number",
            "maxLength":"60",
            "type":"string",
            "description":"The primary emergency contact phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "EcontactEmailOne":{
            "title":"Emergency Contact 1 Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the primary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "EcontactFirstNameOne":{
            "title":"Emergency Contact 1 First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the primary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFee":{
            "title":"Fees Total Amount",
            "type":"number",
            "description":"The sum of the total fee for all the licenses of a location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "BusinessLocationId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for a business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactLastNameTwo":{
            "title":"Emergency Contact 2 Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the secondary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "title":"Primary Phone",
            "maxLength":"60",
            "type":"string",
            "description":"The primary phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "State":{
            "title":"Location State",
            "maxLength":"60",
            "type":"string",
            "description":"The physical address of the state.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Location Country",
            "maxLength":"3",
            "type":"string",
            "description":"The physical address of the country.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarliestExpirationDate":{
            "title":"Earliest License Expiration Date",
            "type":"string",
            "description":"The earliest license expiration date among all the licenses of a location.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LocationType":{
            "title":"Location Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessAddress2":{
            "title":"Business Address 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the physical address of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailAddress1":{
            "title":"Mailing Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the location mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessAddress1":{
            "title":"Business Address 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the physical address of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailAddress2":{
            "title":"Mailing Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the location mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top