Jump to

• Request
• Response

Get an agency address

get

/fscmRestApi/resources/11.13.18.05/publicSectorAgencyAddresses/{publicSectorAgencyAddressesUniqID}

Request

Path Parameters

• publicSectorAgencyAddressesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and AgencyAddressId ---for the Agency Addresses resource and used to uniquely identify an instance of Agency Addresses. The client should not generate the hash key value. Instead, the client should query on the Agency Addresses collection resource with a filter on the primary key values in order to navigate to a specific instance of Agency Addresses.
  
  For example: publicSectorAgencyAddresses?q=AgencyId=<value1>;AgencyAddressId=<value2>

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 : publicSectorAgencyAddresses-item-response

Type: object

Show Source

• Address1: string
  Title: Address

  Maximum Length: 240

  The first address line of the agency address.
• Address2: string
  Title: Address

  Maximum Length: 240

  The second address line of the agency address.
• Address3: string
  Title: Address

  Maximum Length: 240

  The third address line of the agency address.
• Address4: string
  Title: Address

  Maximum Length: 240

  The fourth address line of the agency address.
• AddressCode: string
  Title: Address ID

  Maximum Length: 32

  The unique identifier of the address. Value is mandatory and is entered by the user when the address is created.
• AgencyAddressId: integer
  Title: Address ID

  The unique identifier of the address. Value is mandatory and is system-generated when the address is created. ID is not displayed to the user.
• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.
• CityName: string
  Title: City

  Maximum Length: 60

  The name of the city as part of the agency address.
• CountryCode: string
  Title: Country

  Maximum Length: 3

  The name of the country as part of the agency address.
• CountyCodeIncits: string
  Title: County

  Maximum Length: 60

  The name of the county as part of the agency address.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the agency address.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the agency addess was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last date and time that the agency address was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the agency address.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 10

  The postal code plus four as part of the agency address.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether the address is the primary address of the agency. A value of Y means the address is primary. Default value is N.
• Province: string
  Title: Province

  Maximum Length: 60

  The name of the province as part of the agency address.
• State: string
  Title: State

  Maximum Length: 60

  The name of the state as part of the agency address.
• ValidFromDate: string (date)
  Title: From Date

  The first day that the address may be used.
• ValidToDate: string (date)
  Title: To Date

  The last day that the address may be used.
• ZipCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code as part of the agency address.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the agency address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the agency addess was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The last day that the address may be used.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the agency address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the address is the primary address of the agency. A value of Y means the address is primary. Default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ZipCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The third address line of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCode":{
            "title":"Address ID",
            "maxLength":"32",
            "type":"string",
            "description":"The unique identifier of the address. Value is mandatory and is entered by the user when the address is created.",
            "nullable":false,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The first address line of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "CityName":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "CountyCodeIncits":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the county as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"10",
            "type":"string",
            "description":"The postal code plus four as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the state as part of the agency address.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyAddressId":{
            "title":"Address ID",
            "type":"integer",
            "description":"The unique identifier of the address. Value is mandatory and is system-generated when the address is created. ID is not displayed to the user.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ValidFromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The first day that the address may be used.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The name of the country as part of the agency address.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last date and time that the agency address was updated.",
            "format":"date-time",
            "nullable":false,
            "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