Jump to

• Request
• Response

Create a set of contact address for the user profile

post

/fscmRestApi/resources/11.13.18.05/publicSectorPersonalProfiles/{ProfileId}/child/ProfileLocation

Request

Supported Media Types

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

Path Parameters

• ProfileId: integer
  The unique identifier for a registered public user account profile.

Body ()

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

Root Schema : publicSectorPersonalProfiles-ProfileLocation-item

Type: object

Show Source

• Address1(optional): string
  Address line 1.
• Address2(optional): string
  Address line 2.
• Address3(optional): string
  Address line 3.
• Address4(optional): string
  Address line 4.
• City(optional): string
  Address city.
• Country(optional): string
  Address country.
• County(optional): string
  Address county.
• links(optional): array Items
  Title: Items

  Link Relations
• LocationSiteId(optional): integer(int64)
  The unique identifier for a contact address.
• OnlineFlag(optional): string
  Maximum Length: 1

  Indicates whether this location has a website. Valid values are Y for yes and N for no.
• PostalCode(optional): string
  Address postal code.
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.
• ProfileId(optional): integer(int64)
  The unique identifier for the profile that is associated with the address.
• SiteUseType(optional): string
  Title: Type

  The address type. Valid values are BUSINESS for business and HOME for home.
• State(optional): string
  Address state.
• Status(optional): string
  The status of the address contact point. Valid values are A for active and I for inactive.

{
    "properties":{
        "Address1":{
            "type":"string",
            "description":"Address line 1."
        },
        "Address2":{
            "type":"string",
            "description":"Address line 2."
        },
        "Address3":{
            "type":"string",
            "description":"Address line 3."
        },
        "Address4":{
            "type":"string",
            "description":"Address line 4."
        },
        "City":{
            "type":"string",
            "description":"Address city."
        },
        "Country":{
            "type":"string",
            "description":"Address country."
        },
        "County":{
            "type":"string",
            "description":"Address county."
        },
        "LocationSiteId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a contact address."
        },
        "OnlineFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this location has a website. Valid values are Y for yes and N for no."
        },
        "PostalCode":{
            "type":"string",
            "description":"Address postal code."
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the address."
        },
        "SiteUseType":{
            "type":"string",
            "description":"The address type. Valid values are BUSINESS for business and HOME for home.",
            "title":"Type"
        },
        "State":{
            "type":"string",
            "description":"Address state."
        },
        "Status":{
            "type":"string",
            "description":"The status of the address contact point. Valid values are A for active and I for inactive."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorPersonalProfiles-ProfileLocation-item

Type: object

Show Source

• Address1(optional): string
  Address line 1.
• Address2(optional): string
  Address line 2.
• Address3(optional): string
  Address line 3.
• Address4(optional): string
  Address line 4.
• City(optional): string
  Address city.
• Country(optional): string
  Address country.
• County(optional): string
  Address county.
• links(optional): array Items
  Title: Items

  Link Relations
• LocationSiteId(optional): integer(int64)
  The unique identifier for a contact address.
• OnlineFlag(optional): string
  Maximum Length: 1

  Indicates whether this location has a website. Valid values are Y for yes and N for no.
• PostalCode(optional): string
  Address postal code.
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.
• ProfileId(optional): integer(int64)
  The unique identifier for the profile that is associated with the address.
• SiteUseType(optional): string
  Title: Type

  The address type. Valid values are BUSINESS for business and HOME for home.
• State(optional): string
  Address state.
• Status(optional): string
  The status of the address contact point. Valid values are A for active and I for inactive.

{
    "properties":{
        "Address1":{
            "type":"string",
            "description":"Address line 1."
        },
        "Address2":{
            "type":"string",
            "description":"Address line 2."
        },
        "Address3":{
            "type":"string",
            "description":"Address line 3."
        },
        "Address4":{
            "type":"string",
            "description":"Address line 4."
        },
        "City":{
            "type":"string",
            "description":"Address city."
        },
        "Country":{
            "type":"string",
            "description":"Address country."
        },
        "County":{
            "type":"string",
            "description":"Address county."
        },
        "LocationSiteId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a contact address."
        },
        "OnlineFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this location has a website. Valid values are Y for yes and N for no."
        },
        "PostalCode":{
            "type":"string",
            "description":"Address postal code."
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the address."
        },
        "SiteUseType":{
            "type":"string",
            "description":"The address type. Valid values are BUSINESS for business and HOME for home.",
            "title":"Type"
        },
        "State":{
            "type":"string",
            "description":"Address state."
        },
        "Status":{
            "type":"string",
            "description":"The status of the address contact point. Valid values are A for active and I for inactive."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top