Get a responsible party
get
/fscmRestApi/resources/11.13.18.05/publicSectorResponsibleParties/{publicSectorResponsiblePartiesUniqID}
Request
Path Parameters
-
publicSectorResponsiblePartiesUniqID: integer
This is the hash key of the attributes which make up the composite key--- CaseKey and CaseContactKey ---for the Case Responsible Parties resource and used to uniquely identify an instance of Case Responsible Parties. The client should not generate the hash key value. Instead, the client should query on the Case Responsible Parties collection resource with a filter on the primary key values in order to navigate to a specific instance of Case Responsible Parties.
For example: publicSectorResponsibleParties?q=CaseKey=<value1>;CaseContactKey=<value2>
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorResponsibleParties-item
Type:
Show Source
object-
AccessComments(optional):
string
Title:
CommentsMaximum Length:1000The comments for the case online access request. -
AccessStatus(optional):
string
Title:
Online Access StatusMaximum Length:30The status of the case online access. -
AccessStatusDesc(optional):
string
Title:
Access Status DescriptionMaximum Length:80The status description of the case online access. -
Address1(optional):
string
Title:
Address Line 1Maximum Length:240The first line of the address of the case contact. -
Address2(optional):
string
Title:
Address Line 2Maximum Length:240The second line of the address of the case contact. -
Address3(optional):
string
Title:
Address Line 3Maximum Length:240The third line of the address of the case contact. -
Address4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth line of the address of the case contact. -
CaseContactKey(optional):
integer(int64)
The unique identifier of the case contact.
-
CaseContactPuid(optional):
string
Maximum Length:
480The public unique identifier of the migrated case contact. -
CaseId(optional):
string
Title:
Case IDMaximum Length:50The identifier of the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
CasePuid(optional):
string
Maximum Length:
480The public unique identifier of the migrated case. -
City(optional):
string
Title:
CityMaximum Length:60The city of the case contact. -
ClaimantUserName(optional):
string
Title:
User NameThe user ID of the online case access requestor. -
ContactPartyId(optional):
integer(int64)
Title:
Contact PartyThe party ID of the case contact. -
ContactType(optional):
string
Title:
TypeMaximum Length:15The type of contact for the case. -
ContactTypeDesc(optional):
string
Title:
Contact Type DescriptionMaximum Length:80The description of contact type for the case. -
Country(optional):
string
Title:
CountryMaximum Length:3The country of the case contact. -
County(optional):
string
Title:
CountyMaximum Length:60The county of the case contact. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date and time when the row was created. -
EmailAddress(optional):
string
Title:
EmailMaximum Length:254The email address of the case contact. -
IssueSubtype(optional):
string
Title:
Issue SubtypeMaximum Length:100The name of the issue subtype associated with the case. -
IssueSubtypeId(optional):
string
Title:
Issue Subtype IDMaximum Length:50The unique identifier of the issue subtype of the case. -
IssueType(optional):
string
Title:
Issue TypeMaximum Length:100The name of the issue type associated with the case. -
IssueTypeId(optional):
string
Title:
Issue Type IDMaximum Length:50The unique identifier of the issue type of the case. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who last updated the row. -
links(optional):
array Items
Title:
ItemsLink Relations -
PersonFirstName(optional):
string
Title:
First NameMaximum Length:150The first name of the case contact. -
PersonLastName(optional):
string
Title:
Last NameMaximum Length:150The last name of the case contact. -
PersonMiddleName(optional):
string
Title:
Middle NameMaximum Length:60The middle name of the case contact. -
PersonNameSuffix(optional):
string
Title:
Name SuffixMaximum Length:30The suffix of the case contact. -
PersonTitle(optional):
string
Title:
TitleMaximum Length:60The title of the case contact. -
PhoneAreaCode(optional):
string
Maximum Length:
10The phone area code of the case contact. -
PhoneCountryCode(optional):
string
Maximum Length:
10The phone country code of the case contact. -
PhoneExtension(optional):
string
Maximum Length:
20The phone extension of the case contact. -
PhoneNumber(optional):
string
Title:
PhoneMaximum Length:100The phone number of the case contact. -
PostalCode(optional):
string
Title:
Postal CodeMaximum Length:60The postal code of the case contact. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 CodeMaximum Length:10The postal plus code of the case contact. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates if the contact is the primary case contact. -
Province(optional):
string
Title:
ProvinceMaximum Length:60The province of case contact. -
ResponsiblePartyPhone(optional):
string
The phone number of the contact with country code.
-
State(optional):
string
Title:
StateMaximum Length:60The state of the case contact. -
UserFirstName(optional):
string
Title:
Applicant First NameMaximum Length:150The first name of the online case access requestor. -
UserLastName(optional):
string
Title:
Applicant Last NameMaximum Length:150The last name of the online case access requestor.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.