Get all license agents for a contractor license
get
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents
Request
Path Parameters
-
LicenseKey: integer
Automatically generated number that uniquely identifies the license.
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 license agent that matches the primary keys specified. Finder Variables:
- LicenseAgentKey; integer; The license agent key for a contractor license.
- PrimaryKey: Finds the license agent that matches the primary keys specified. Finder Variables:
-
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorContractorLicenses-ContractorLicenseAgents
Type:
Show Source
object
-
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.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorContractorLicenses-ContractorLicenseAgents-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
First line of the address of the person who is a contact for the contractor license. -
Address2(optional):
string
Maximum Length:
240
Second line of the address of the person who is a contact for the contractor license. -
Address3(optional):
string
Maximum Length:
240
Third line of the address of the person who is a contact for the contractor license. -
Address4(optional):
string
Maximum Length:
240
Fourth line of the address of the person who is a contact for the contractor license. -
AssociateDate(optional):
string(date-time)
The date that the contact person was associated with the contractor license.
-
AuthorizeStatus(optional):
string
Maximum Length:
30
Status of the contact person who is associated with the contractor license. The status indicates if the person is a verified contact. -
City(optional):
string
Maximum Length:
60
City for the address of the person who is a contact for the contractor license. -
ContactBizPartyId(optional):
integer(int64)
Business party ID associated with the entity that holds the license.
-
ContactBizProfileId(optional):
integer(int64)
Business Profile ID associated with the contact person if the contact person is a registered user.
-
ContactId(optional):
string
Maximum Length:
18
Contact ID associated with the contact person for the business license. This attribute is not currently used. -
ContactPartyId(optional):
integer(int64)
Party ID associated with the contact person if the contact person is a registered user.
-
ContactProfileId(optional):
integer(int64)
Profile ID associated with the contact person if the contact person is a registered user.
-
ContactType(optional):
string
Maximum Length:
30
The contact type or role of the person associated with the license. This attribute is not currently used. -
Country(optional):
string
Maximum Length:
3
Country for the address of the person who is a contact for the contractor license. -
County(optional):
string
Maximum Length:
60
Country for the address of the person who is a contact for the contractor license. -
DisassociateDate(optional):
string(date-time)
The date that a former contact person was disassociated from the contractor license.
-
EmailAddress(optional):
string
Maximum Length:
320
Email address of the person who is a contact for the contractor license. -
JobTitle(optional):
string
Maximum Length:
60
The job title of the person who is a contact for the contractor license. -
LicenseAgentKey(optional):
integer(int64)
The unique identifier for the person who is an authorized contact for a contractor license.
-
LicenseKey(optional):
integer(int64)
The unique identifier for a contractor license.
-
links(optional):
array Items
Title:
Items
Link Relations -
OrganizationName(optional):
string
Maximum Length:
360
Name of the organization of the contact person for the contractor license. -
PersonFirstName(optional):
string
Maximum Length:
150
First name of the person who is authorized as a contact for the contractor license. -
PersonLastName(optional):
string
Maximum Length:
150
Last name of the person who is authorized as a contact for the contractor license. -
PersonMiddleName(optional):
string
Maximum Length:
60
Middle name of the person who is authorized as a contact for the contractor license. -
PersonName(optional):
string
Maximum Length:
450
Full concatenated name of the person who is authorized as a contact for the contractor license. This includes the person's first, middle, and last names and any name suffix. -
PersonNameSuffix(optional):
string
Maximum Length:
30
Name suffix for the person who is authorized as a contact for the contractor license. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30
Salutation of the person associated with the contractor license. -
PhoneAreaCode(optional):
string
Maximum Length:
10
Phone area code of the person who is a contact for the contractor license. -
PhoneCountryCode(optional):
string
Maximum Length:
10
Phone country code of the person who is a contact for the contractor license. -
PhoneExtension(optional):
string
Maximum Length:
20
Phone extension of the person who is a contact for the contractor license. -
PhoneNumber(optional):
string
Maximum Length:
40
Phone of the person who is a contact for the contractor license. -
PostalCode(optional):
string
Maximum Length:
60
Postal code for the address of the person who is a contact for the contractor license. -
PrimaryFlag(optional):
string
Maximum Length:
1
Identifies whether the person associated with the license is the preferred contact for the contractor. This attribute is not currently used. -
Province(optional):
string
Maximum Length:
60
Province for the address of the person who is a contact for the contractor license. -
State(optional):
string
Maximum Length:
60
State for the address of the person who is a contact for the contractor license. -
VerificationDate(optional):
string(date)
The date that the user last updated the authorization status.
-
VerifiedBy(optional):
string
Maximum Length:
64
The user who updated the authorization status.
Nested Schema : link
Type:
Show Source
object
-
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.