Jump to

• Request
• Response

Get all business profiles of a registered public user

get

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the business profile that matches the primary key specified. Finder Variables:
    • ProfileId; integer; The unique identifier of a registered public user's business profile.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorBusinessProfiles

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessProfiles-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorBusinessProfiles-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessProfiles-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : publicSectorBusinessProfiles-item

Type: object

Show Source

• BusinessName(optional): string
  Maximum Length: 60

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

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

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

  Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no.
• links(optional): array Items
  Title: Items

  Link Relations
• ProfileContactPointEmail(optional): array Profile Emails
  Title: Profile Emails

  The business profiles resource is used to view, create, or modify a registered public user business profile.
• ProfileContactPointPhone(optional): array Profile Phones
  Title: Profile Phones

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

  The business profiles resource is used to view, create, or modify a registered public user business profile.
• ProfileName(optional): string
  Maximum Length: 60

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

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

{
    "properties":{
        "BusinessName":{
            "maxLength":60,
            "type":"string",
            "description":"The business name for a registered public user account business profile."
        },
        "BusinessType":{
            "maxLength":30,
            "type":"string",
            "description":"The business type for a registered public user account business profile."
        },
        "CntrctrVerificationStatus":{
            "maxLength":2,
            "type":"string",
            "description":"The verification status of a registered public user's standing as a contractor."
        },
        "IsContractor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no."
        },
        "ProfileContactPointEmail":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointEmail-item"
            },
            "type":"array",
            "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
            "title":"Profile Emails"
        },
        "ProfileContactPointPhone":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointPhone-item"
            },
            "type":"array",
            "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
            "title":"Profile Phones"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a registered public user account profile."
        },
        "ProfileLocation":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileLocation-item"
            },
            "type":"array",
            "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
            "title":"Profile Locations"
        },
        "ProfileName":{
            "maxLength":60,
            "type":"string",
            "description":"The registered public user account profile name."
        },
        "ProfileStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The profile status. Valid values are  A for active and I for inactive."
        },
        "PscUserId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a registered public user reference row."
        },
        "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 : Profile Emails

Type: array

Title: Profile Emails

The business profiles resource is used to view, create, or modify a registered public user business profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileContactPointEmail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointEmail-item"
    },
    "type":"array",
    "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
    "title":"Profile Emails"
}

Nested Schema : Profile Phones

Type: array

Title: Profile Phones

The business profiles resource is used to view, create, or modify a registered public user business profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileContactPointPhone-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointPhone-item"
    },
    "type":"array",
    "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
    "title":"Profile Phones"
}

Nested Schema : Profile Locations

Type: array

Title: Profile Locations

The business profiles resource is used to view, create, or modify a registered public user business profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileLocation-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileLocation-item"
    },
    "type":"array",
    "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
    "title":"Profile Locations"
}

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

Nested Schema : publicSectorBusinessProfiles-ProfileContactPointEmail-item

Type: object

Show Source

• ContactPointPurpose(optional): string
  Title: Type

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

  The email address for the email contact point.
• links(optional): array Items
  Title: Items

  Link Relations
• PrimaryFlag(optional): 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(optional): integer(int64)
  The unique identifier for the profile that is associated with the email contact point.
• Status(optional): string
  The status of the email contact point. Valid values are A for active and I for inactive.

{
    "properties":{
        "ContactPointPurpose":{
            "type":"string",
            "description":"The email type. Valid values are BUSINESS for work and PERSONAL for home.",
            "title":"Type"
        },
        "ContactPtId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the email contact point."
        },
        "EmailAddress":{
            "type":"string",
            "description":"The email address for the email contact point.",
            "title":"Email"
        },
        "PrimaryFlag":{
            "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.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the email contact point."
        },
        "Status":{
            "type":"string",
            "description":"The status of the email 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 : publicSectorBusinessProfiles-ProfileContactPointPhone-item

Type: object

Show Source

• ContactPointPurpose(optional): string
  Title: Type

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

  Link Relations
• PhoneAreaCode(optional): string
  The phone area code.
• PhoneCountryCode(optional): string
  The phone country code.
• PhoneExtension(optional): string
  The phone extension.
• PhoneFull(optional): string
  The full formatted phone number.
• PhoneNumber(optional): string
  The phone number.
• PhoneType(optional): string
  Title: Type

  The phone type. Valid values are WORK, HOME, and MOBILE.
• PrimaryFlag(optional): 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(optional): integer(int64)
  The unique identifier for the profile that is associated with the phone contact point.
• Status(optional): string
  The status of the phone contact point. Valid values are A for active and I for inactive.

{
    "properties":{
        "ContactPointPurpose":{
            "type":"string",
            "description":"The phone type. Valid values are BUSINESS for work and PERSONAL for home.",
            "title":"Type"
        },
        "ContactPtId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the phone contact point."
        },
        "PhoneAreaCode":{
            "type":"string",
            "description":"The phone area code."
        },
        "PhoneCountryCode":{
            "type":"string",
            "description":"The phone country code."
        },
        "PhoneExtension":{
            "type":"string",
            "description":"The phone extension."
        },
        "PhoneFull":{
            "type":"string",
            "description":"The full formatted phone number."
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The phone number."
        },
        "PhoneType":{
            "type":"string",
            "description":"The phone type. Valid values are WORK, HOME, and MOBILE.",
            "title":"Type"
        },
        "PrimaryFlag":{
            "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.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the phone contact point."
        },
        "Status":{
            "type":"string",
            "description":"The status of the phone 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 : publicSectorBusinessProfiles-ProfileLocation-item

Type: object

Show Source

• Address1(optional): string
  The first line of the address.
• Address2(optional): string
  The second line of the address.
• Address3(optional): string
  The third line of the address.
• Address4(optional): string
  The fourth line of the address.
• AddressFull(optional): string
  The full address for a profile address.
• City(optional): string
  The city of the address.
• Country(optional): string
  The country of the address.
• County(optional): string
  The county of the address.
• links(optional): array Items
  Title: Items

  Link Relations
• LocationSiteId(optional): integer(int64)
  The unique identifier for a profile 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
  The postal code of the address.
• 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
  The state for the address.
• Status(optional): string
  The status of the address. Valid values are A for active and I for inactive.

{
    "properties":{
        "Address1":{
            "type":"string",
            "description":"The first line of the address."
        },
        "Address2":{
            "type":"string",
            "description":"The second line of the address."
        },
        "Address3":{
            "type":"string",
            "description":"The third line of the address."
        },
        "Address4":{
            "type":"string",
            "description":"The fourth line of the address."
        },
        "AddressFull":{
            "type":"string",
            "description":"The full address for a profile address."
        },
        "City":{
            "type":"string",
            "description":"The city of the address."
        },
        "Country":{
            "type":"string",
            "description":"The country of the address."
        },
        "County":{
            "type":"string",
            "description":"The county of the address."
        },
        "LocationSiteId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a profile 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":"The postal code of the address."
        },
        "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":"The state for the address."
        },
        "Status":{
            "type":"string",
            "description":"The status of the address. 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"
}

Back to Top