Jump to

• Request
• Response

Update a business profile of a registered public user

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}

Request

Path Parameters

• ProfileId(required): integer(int64)
  The unique identifier for a registered public user account profile.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BusinessName: string
  Maximum Length: 60

  The business name for a registered public user account business profile.
• BusinessType: string
  Maximum Length: 30

  The business type for a registered public user account business profile.
• CntrctrVerificationStatus: string
  Maximum Length: 2

  The verification status of a registered public user's standing as a contractor.
• IsContractor: string
  Maximum Length: 1

  Default Value: N

  Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no.
• JobTitle: string
  Maximum Length: 60

  The person's job title.
• ProfileContactPointEmail: array Profile Emails
  Title: Profile Emails

  The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.
• ProfileContactPointPhone: array Profile Phones
  Title: Profile Phones

  The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.
• ProfileLocation: array Profile Locations
  Title: Profile Locations

  The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.
• ProfileName: string
  Maximum Length: 60

  The registered public user account profile name.
• ProfileStatus: string
  Maximum Length: 1

  Default Value: A

  The profile status. Valid values are A for active and I for inactive.

{
    "type":"object",
    "properties":{
        "ProfileLocation":{
            "title":"Profile Locations",
            "type":"array",
            "description":"The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileLocation-item-patch-request"
            }
        },
        "BusinessName":{
            "maxLength":60,
            "type":"string",
            "description":"The business name for a registered public user account business profile.",
            "nullable":true
        },
        "IsContractor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no.",
            "nullable":false,
            "default":"N"
        },
        "BusinessType":{
            "maxLength":30,
            "type":"string",
            "description":"The business type for a registered public user account business profile.",
            "nullable":true
        },
        "CntrctrVerificationStatus":{
            "maxLength":2,
            "type":"string",
            "description":"The verification status of a registered public user's standing as a contractor.",
            "nullable":true
        },
        "ProfileStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The profile status. Valid values are  A for active and I for inactive.",
            "nullable":false,
            "default":"A"
        },
        "ProfileName":{
            "maxLength":60,
            "type":"string",
            "description":"The registered public user account profile name.",
            "nullable":false
        },
        "ProfileContactPointEmail":{
            "title":"Profile Emails",
            "type":"array",
            "description":"The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileContactPointEmail-item-patch-request"
            }
        },
        "JobTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The person's job title.",
            "nullable":true
        },
        "ProfileContactPointPhone":{
            "title":"Profile Phones",
            "type":"array",
            "description":"The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileContactPointPhone-item-patch-request"
            }
        }
    }
}

Nested Schema : Profile Emails

Type: array

Title: Profile Emails

The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.

Show Source

• Array of: object schema

{
    "title":"Profile Emails",
    "type":"array",
    "description":"The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileContactPointEmail-item-patch-request"
    }
}

Nested Schema : Profile Phones

Type: array

Title: Profile Phones

The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileContactPointPhone-item-patch-request

{
    "title":"Profile Phones",
    "type":"array",
    "description":"The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileContactPointPhone-item-patch-request"
    }
}

Nested Schema : Profile Locations

Type: array

Title: Profile Locations

The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileLocation-item-patch-request

{
    "title":"Profile Locations",
    "type":"array",
    "description":"The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileLocation-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ContactPointPurpose: string
  Title: Type

  The email type. Valid values are BUSINESS for work and PERSONAL for home.
• EmailAddress: string
  Title: Email

  The email address for the email contact point.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.
• Status: string
  The status of the email contact point. Valid values are A for active and I for inactive.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"The status of the email contact point. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        },
        "ContactPointPurpose":{
            "title":"Type",
            "type":"string",
            "description":"The email type. Valid values are BUSINESS for work and PERSONAL for home.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.",
            "nullable":false
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The email address for the email contact point.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : publicSectorBusinessProfiles-ProfileContactPointPhone-item-patch-request

Type: object

Show Source

• ContactPointPurpose: string
  Title: Type

  The phone type. Valid values are BUSINESS for work and PERSONAL for home.
• PhoneAreaCode: string
  The phone area code.
• PhoneCountryCode: string
  The phone country code.
• PhoneExtension: string
  The phone extension.
• PhoneNumber: string
  The phone number.
• PhoneType: string
  Title: Type

  The phone type. Valid values are WORK, HOME, and MOBILE.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.
• Status: string
  The status of the phone contact point. Valid values are A for active and I for inactive.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"The status of the phone contact point. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        },
        "PhoneCountryCode":{
            "type":"string",
            "description":"The phone country code.",
            "nullable":true
        },
        "PhoneAreaCode":{
            "type":"string",
            "description":"The phone area code.",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.",
            "nullable":false
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are WORK, HOME, and MOBILE.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPointPurpose":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are BUSINESS for work and PERSONAL for home.",
            "nullable":true
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The phone number.",
            "nullable":true
        },
        "PhoneExtension":{
            "type":"string",
            "description":"The phone extension.",
            "nullable":true
        }
    }
}

Nested Schema : publicSectorBusinessProfiles-ProfileLocation-item-patch-request

Type: object

Show Source

• Address1: string
  The first line of the address.
• Address2: string
  The second line of the address.
• Address3: string
  The third line of the address.
• Address4: string
  The fourth line of the address.
• City: string
  The city of the address.
• Country: string
  The country of the address.
• County: string
  The county of the address.
• OnlineFlag: string
  Maximum Length: 1

  Indicates whether this location has a website. Valid values are Y for yes and N for no.
• PostalCode: string
  The postal code of the address.
• PrimaryFlag: 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.
• SiteUseType: string
  Title: Type

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

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"The status of the address. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "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.",
            "nullable":false
        },
        "Address2":{
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalCode":{
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "Address3":{
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "Address1":{
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "type":"string",
            "description":"The city of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "County":{
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "Address4":{
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "State":{
            "type":"string",
            "description":"The state for the address.",
            "nullable":true,
            "x-queryable":false
        },
        "Country":{
            "type":"string",
            "description":"The country of the address.",
            "nullable":false,
            "x-queryable":false
        },
        "OnlineFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this location has a website. Valid values are Y for yes and N for no.",
            "nullable":false
        },
        "SiteUseType":{
            "title":"Type",
            "type":"string",
            "description":"The address type. Valid values are BUSINESS for business and HOME for home.",
            "nullable":false,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorBusinessProfiles-item-response

Type: object

Show Source

• BusinessName: string
  Maximum Length: 60

  The business name for a registered public user account business profile.
• BusinessType: string
  Maximum Length: 30

  The business type for a registered public user account business profile.
• CntrctrVerificationStatus: string
  Maximum Length: 2

  The verification status of a registered public user's standing as a contractor.
• IsContractor: string
  Maximum Length: 1

  Default Value: N

  Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no.
• JobTitle: string
  Maximum Length: 60

  The person's job title.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProfileContactPointEmail: array Profile Emails
  Title: Profile Emails

  The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.
• ProfileContactPointPhone: array Profile Phones
  Title: Profile Phones

  The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.
• ProfileId: integer (int64)
  The unique identifier for a registered public user account profile.
• ProfileLocation: array Profile Locations
  Title: Profile Locations

  The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.
• ProfileName: string
  Maximum Length: 60

  The registered public user account profile name.
• ProfileStatus: string
  Maximum Length: 1

  Default Value: A

  The profile status. Valid values are A for active and I for inactive.
• PscUserId: integer (int64)
  The unique identifier for a registered public user reference row.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for a registered public user account profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProfileLocation":{
            "title":"Profile Locations",
            "type":"array",
            "description":"The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileLocation-item-response"
            }
        },
        "PscUserId":{
            "type":"integer",
            "description":"The unique identifier for a registered public user reference row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessName":{
            "maxLength":60,
            "type":"string",
            "description":"The business name for a registered public user account business profile.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessType":{
            "maxLength":30,
            "type":"string",
            "description":"The business type for a registered public user account business profile.",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The profile status. Valid values are  A for active and I for inactive.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "ProfileName":{
            "maxLength":60,
            "type":"string",
            "description":"The registered public user account profile name.",
            "nullable":false,
            "x-queryable":true
        },
        "JobTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The person's job title.",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileContactPointPhone":{
            "title":"Profile Phones",
            "type":"array",
            "description":"The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileContactPointPhone-item-response"
            }
        },
        "IsContractor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "CntrctrVerificationStatus":{
            "maxLength":2,
            "type":"string",
            "description":"The verification status of a registered public user's standing as a contractor.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProfileContactPointEmail":{
            "title":"Profile Emails",
            "type":"array",
            "description":"The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.",
            "items":{
                "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileContactPointEmail-item-response"
            }
        }
    }
}

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 : Profile Emails

Type: array

Title: Profile Emails

The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileContactPointEmail-item-response

{
    "title":"Profile Emails",
    "type":"array",
    "description":"The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileContactPointEmail-item-response"
    }
}

Nested Schema : Profile Phones

Type: array

Title: Profile Phones

The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileContactPointPhone-item-response

{
    "title":"Profile Phones",
    "type":"array",
    "description":"The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileContactPointPhone-item-response"
    }
}

Nested Schema : Profile Locations

Type: array

Title: Profile Locations

The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileLocation-item-response

{
    "title":"Profile Locations",
    "type":"array",
    "description":"The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.",
    "items":{
        "$ref":"#/components/schemas/publicSectorBusinessProfiles-ProfileLocation-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorBusinessProfiles-ProfileContactPointEmail-item-response

Type: object

Show Source

• ContactPointPurpose: string
  Title: Type

  The email type. Valid values are BUSINESS for work and PERSONAL for home.
• ContactPtId: integer (int64)
  The unique identifier for the email contact point.
• EmailAddress: string
  Title: Email

  The email address for the email contact point.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.
• ProfileId: integer (int64)
  The unique identifier for the profile that is associated with the email contact point.
• Status: string
  The status of the email contact point. Valid values are A for active and I for inactive.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the email contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"The status of the email contact point. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactPtId":{
            "type":"integer",
            "description":"The unique identifier for the email contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ContactPointPurpose":{
            "title":"Type",
            "type":"string",
            "description":"The email type. Valid values are BUSINESS for work and PERSONAL for home.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The email address for the email contact point.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : publicSectorBusinessProfiles-ProfileContactPointPhone-item-response

Type: object

Show Source

• ContactPointPurpose: string
  Title: Type

  The phone type. Valid values are BUSINESS for work and PERSONAL for home.
• ContactPtId: integer (int64)
  The unique identifier for the phone contact point.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PhoneAreaCode: string
  The phone area code.
• PhoneCountryCode: string
  The phone country code.
• PhoneExtension: string
  The phone extension.
• PhoneFull: string
  Read Only: true

  The full formatted phone number.
• PhoneNumber: string
  The phone number.
• PhoneType: string
  Title: Type

  The phone type. Valid values are WORK, HOME, and MOBILE.
• PrimaryFlag: string
  Title: Primary

  Maximum Length: 1

  Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.
• ProfileId: integer (int64)
  The unique identifier for the profile that is associated with the phone contact point.
• Status: string
  The status of the phone contact point. Valid values are A for active and I for inactive.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the phone contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"The status of the phone contact point. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        },
        "PhoneCountryCode":{
            "type":"string",
            "description":"The phone country code.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "type":"string",
            "description":"The phone area code.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.",
            "nullable":false,
            "x-queryable":true
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are WORK, HOME, and MOBILE.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPtId":{
            "type":"integer",
            "description":"The unique identifier for the phone contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ContactPointPurpose":{
            "title":"Type",
            "type":"string",
            "description":"The phone type. Valid values are BUSINESS for work and PERSONAL for home.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PhoneFull":{
            "type":"string",
            "description":"The full formatted phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "type":"string",
            "description":"The phone extension.",
            "nullable":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 : publicSectorBusinessProfiles-ProfileLocation-item-response

Type: object

Show Source

• Address1: string
  The first line of the address.
• Address2: string
  The second line of the address.
• Address3: string
  The third line of the address.
• Address4: string
  The fourth line of the address.
• AddressFull: string
  Read Only: true

  The full address for a profile address.
• City: string
  The city of the address.
• Country: string
  The country of the address.
• County: string
  The county of the address.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationSiteId: integer (int64)
  The unique identifier for a profile address.
• OnlineFlag: string
  Maximum Length: 1

  Indicates whether this location has a website. Valid values are Y for yes and N for no.
• PostalCode: string
  The postal code of the address.
• PrimaryFlag: 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: integer (int64)
  The unique identifier for the profile that is associated with the address.
• SiteUseType: string
  Title: Type

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

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"The status of the address. Valid values are A for active and I for inactive.",
            "nullable":false,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressFull":{
            "type":"string",
            "description":"The full address for a profile address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalCode":{
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "Address3":{
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "Address1":{
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "type":"string",
            "description":"The city of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "County":{
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "Address4":{
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "State":{
            "type":"string",
            "description":"The state for the address.",
            "nullable":true,
            "x-queryable":false
        },
        "Country":{
            "type":"string",
            "description":"The country of the address.",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OnlineFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this location has a website. Valid values are Y for yes and N for no.",
            "nullable":false,
            "x-queryable":true
        },
        "LocationSiteId":{
            "type":"integer",
            "description":"The unique identifier for a profile address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SiteUseType":{
            "title":"Type",
            "type":"string",
            "description":"The address type. Valid values are BUSINESS for business and HOME for home.",
            "nullable":false,
            "x-queryable":false
        }
    }
}

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"
    }
}

Links

ProfileContactPointEmail

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointEmail

Parameters:

• ProfileId: $request.path.ProfileId

The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.

ProfileContactPointPhone

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileContactPointPhone

Parameters:

• ProfileId: $request.path.ProfileId

The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.

ProfileLocation

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles/{ProfileId}/child/ProfileLocation

Parameters:

• ProfileId: $request.path.ProfileId

The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.

Back to Top