Jump to

• Request
• Response

Update an agency address

patch

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

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorAgencyAddressesUniqID: integer
  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>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorAgencyAddresses-item

Type: object

Show Source

• Address1(optional): string
  Title: Address

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

  The fourth address line of the agency address.
• AddressCode(optional): string
  Maximum Length: 32

  The unique identifier of the address. Value is mandatory and is entered by the user when the address is created.
• AgencyAddressId(optional): integer(int64)
  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(optional): 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(optional): string
  Title: City

  Maximum Length: 60

  The name of the city as part of the agency address.
• CountryCode(optional): string
  Maximum Length: 3

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

  Maximum Length: 60

  The name of the county as part of the agency address.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the agency address.
• CreationDate(optional): string(date-time)
  The date and time that the agency addess was created.
• LastUpdateDate(optional): string(date-time)
  The last date and time that the agency address was updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the agency address.
• links(optional): array Items
  Title: Items

  Link Relations
• PostalPlus4Code(optional): string
  Title: Postal Plus 4 Code

  Maximum Length: 10

  The postal code plus four as part of the agency address.
• PrimaryFlag(optional): string
  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(optional): string
  Title: Province

  Maximum Length: 60

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

  Maximum Length: 60

  The name of the state as part of the agency address.
• ValidFromDate(optional): string(date)
  The first day that the address may be used.
• ValidToDate(optional): string(date)
  The last day that the address may be used.
• ZipCode(optional): string
  Title: Postal Code

  Maximum Length: 60

  The postal code as part of the agency address.

{
    "type":"object",
    "properties":{
        "Address1":{
            "title":"Address",
            "description":"The first address line of the agency address.",
            "type":"string",
            "maxLength":240
        },
        "Address2":{
            "title":"Address",
            "description":"The second address line of the agency address.",
            "type":"string",
            "maxLength":240
        },
        "Address3":{
            "title":"Address",
            "description":"The third address line of the agency address.",
            "type":"string",
            "maxLength":240
        },
        "Address4":{
            "title":"Address",
            "description":"The fourth address line of the agency address.",
            "type":"string",
            "maxLength":240
        },
        "AddressCode":{
            "description":"The unique identifier of the address. Value is mandatory and is entered by the user when the address is created.",
            "type":"string",
            "maxLength":32
        },
        "AgencyAddressId":{
            "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.",
            "type":"integer",
            "format":"int64"
        },
        "AgencyId":{
            "title":"Agency ID",
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "CityName":{
            "title":"City",
            "description":"The name of the city as part of the agency address.",
            "type":"string",
            "maxLength":60
        },
        "CountryCode":{
            "description":"The name of the country as part of the agency address.",
            "type":"string",
            "maxLength":3
        },
        "CountyCodeIncits":{
            "title":"County",
            "description":"The name of the county as part of the agency address.",
            "type":"string",
            "maxLength":60
        },
        "CreatedBy":{
            "description":"The user who created the agency address.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time that the agency addess was created.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdateDate":{
            "description":"The last date and time that the agency address was updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the agency address.",
            "type":"string",
            "maxLength":64
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "description":"The postal code plus four as part of the agency address.",
            "type":"string",
            "maxLength":10
        },
        "PrimaryFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "Province":{
            "title":"Province",
            "description":"The name of the province as part of the agency address.",
            "type":"string",
            "maxLength":60
        },
        "State":{
            "title":"State",
            "description":"The name of the state as part of the agency address.",
            "type":"string",
            "maxLength":60
        },
        "ValidFromDate":{
            "description":"The first day that the address may be used.",
            "type":"string",
            "format":"date"
        },
        "ValidToDate":{
            "description":"The last day that the address may be used.",
            "type":"string",
            "format":"date"
        },
        "ZipCode":{
            "title":"Postal Code",
            "description":"The postal code as part of the agency address.",
            "type":"string",
            "maxLength":60
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorAgencyAddresses-item

Type: object

Show Source

• Address1(optional): string
  Title: Address

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

  The fourth address line of the agency address.
• AddressCode(optional): string
  Maximum Length: 32

  The unique identifier of the address. Value is mandatory and is entered by the user when the address is created.
• AgencyAddressId(optional): integer(int64)
  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(optional): 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(optional): string
  Title: City

  Maximum Length: 60

  The name of the city as part of the agency address.
• CountryCode(optional): string
  Maximum Length: 3

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

  Maximum Length: 60

  The name of the county as part of the agency address.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the agency address.
• CreationDate(optional): string(date-time)
  The date and time that the agency addess was created.
• LastUpdateDate(optional): string(date-time)
  The last date and time that the agency address was updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the agency address.
• links(optional): array Items
  Title: Items

  Link Relations
• PostalPlus4Code(optional): string
  Title: Postal Plus 4 Code

  Maximum Length: 10

  The postal code plus four as part of the agency address.
• PrimaryFlag(optional): string
  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(optional): string
  Title: Province

  Maximum Length: 60

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

  Maximum Length: 60

  The name of the state as part of the agency address.
• ValidFromDate(optional): string(date)
  The first day that the address may be used.
• ValidToDate(optional): string(date)
  The last day that the address may be used.
• ZipCode(optional): string
  Title: Postal Code

  Maximum Length: 60

  The postal code as part of the agency address.

{
    "type":"object",
    "properties":{
        "Address1":{
            "title":"Address",
            "description":"The first address line of the agency address.",
            "type":"string",
            "maxLength":240
        },
        "Address2":{
            "title":"Address",
            "description":"The second address line of the agency address.",
            "type":"string",
            "maxLength":240
        },
        "Address3":{
            "title":"Address",
            "description":"The third address line of the agency address.",
            "type":"string",
            "maxLength":240
        },
        "Address4":{
            "title":"Address",
            "description":"The fourth address line of the agency address.",
            "type":"string",
            "maxLength":240
        },
        "AddressCode":{
            "description":"The unique identifier of the address. Value is mandatory and is entered by the user when the address is created.",
            "type":"string",
            "maxLength":32
        },
        "AgencyAddressId":{
            "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.",
            "type":"integer",
            "format":"int64"
        },
        "AgencyId":{
            "title":"Agency ID",
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "CityName":{
            "title":"City",
            "description":"The name of the city as part of the agency address.",
            "type":"string",
            "maxLength":60
        },
        "CountryCode":{
            "description":"The name of the country as part of the agency address.",
            "type":"string",
            "maxLength":3
        },
        "CountyCodeIncits":{
            "title":"County",
            "description":"The name of the county as part of the agency address.",
            "type":"string",
            "maxLength":60
        },
        "CreatedBy":{
            "description":"The user who created the agency address.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time that the agency addess was created.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdateDate":{
            "description":"The last date and time that the agency address was updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the agency address.",
            "type":"string",
            "maxLength":64
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "description":"The postal code plus four as part of the agency address.",
            "type":"string",
            "maxLength":10
        },
        "PrimaryFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "Province":{
            "title":"Province",
            "description":"The name of the province as part of the agency address.",
            "type":"string",
            "maxLength":60
        },
        "State":{
            "title":"State",
            "description":"The name of the state as part of the agency address.",
            "type":"string",
            "maxLength":60
        },
        "ValidFromDate":{
            "description":"The first day that the address may be used.",
            "type":"string",
            "format":"date"
        },
        "ValidToDate":{
            "description":"The last day that the address may be used.",
            "type":"string",
            "format":"date"
        },
        "ZipCode":{
            "title":"Postal Code",
            "description":"The postal code as part of the agency address.",
            "type":"string",
            "maxLength":60
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top