Get all license agents for a contractor license
get
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseAgents
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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.
- RowFinder: Finds the contractor license agent that matches the specified filter values.
Finder Variables:- value; string; The filter values to be applied when finding the contractor license agents information. Filtering options include Person Name, Business Name, Email, Phone Country Code, Phone Area Code, Phone Number, Phone Extension, Contact Type, and Contact Status.
- PrimaryKey: Finds the license agent that matches the primary keys specified.
-
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.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActiveLastUpdateBy; string; Indicates the user who last updated the contact active status.
- ActiveLastUpdateDate; string; Indicates the date when the user last updated the contact active status.
- Address1; string; First line of the address of the person who is a contact for the contractor license.
- Address2; string; Second line of the address of the person who is a contact for the contractor license.
- Address3; string; Third line of the address of the person who is a contact for the contractor license.
- Address4; string; Fourth line of the address of the person who is a contact for the contractor license.
- AssociateDate; string; The date that the contact person was associated with the contractor license.
- AuthorizeAgentFlag; string; Indicates whether the contact person is an authorized user of the license.
- AuthorizeStatus; string; Status of the contact person who is associated with the contractor license. The status indicates if the person is a verified contact.
- City; string; City for the address of the person who is a contact for the contractor license.
- ContactActive; string; Indicates the status for the contact person.
- ContactBizPartyId; integer; Business party ID associated with the entity that holds the license.
- ContactBizProfileId; integer; Business Profile ID associated with the contact person if the contact person is a registered user.
- ContactId; string; Contact ID associated with the contact person for the business license. This attribute is not currently used.
- ContactPartyId; integer; Party ID associated with the contact person if the contact person is a registered user.
- ContactProfileId; integer; Profile ID associated with the contact person if the contact person is a registered user.
- ContactType; string; The contact type or role of the person associated with the license. This attribute is not currently used.
- Country; string; Country for the address of the person who is a contact for the contractor license.
- County; string; Country for the address of the person who is a contact for the contractor license.
- DisassociateDate; string; The date that a former contact person was disassociated from the contractor license.
- EmailAddress; string; Email address of the person who is a contact for the contractor license.
- JobTitle; string; The job title of the person who is a contact for the contractor license.
- LicenseAgentKey; integer; The unique identifier for the person who is an authorized contact for a contractor license.
- LicenseHolderFlag; string; Indicates whether the contact person is a license holder.
- LicenseKey; integer; The unique identifier for a contractor license.
- OrganizationName; string; Name of the organization of the contact person for the contractor license.
- PersonFirstName; string; First name of the person who is authorized as a contact for the contractor license.
- PersonLastName; string; Last name of the person who is authorized as a contact for the contractor license.
- PersonMiddleName; string; Middle name of the person who is authorized as a contact for the contractor license.
- PersonName; string; 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; string; Name suffix for the person who is authorized as a contact for the contractor license.
- PersonPreNameAdjunct; string; Salutation of the person associated with the contractor license.
- PhoneAreaCode; string; Phone area code of the person who is a contact for the contractor license.
- PhoneCountryCode; string; Phone country code of the person who is a contact for the contractor license.
- PhoneExtension; string; Phone extension of the person who is a contact for the contractor license.
- PhoneNumber; string; Phone of the person who is a contact for the contractor license.
- PostalCode; string; Postal code for the address of the person who is a contact for the contractor license.
- PrimaryFlag; string; Identifies whether the person associated with the license is the preferred contact for the contractor. This attribute is not currently used.
- Province; string; Province for the address of the person who is a contact for the contractor license.
- State; string; State for the address of the person who is a contact for the contractor license.
- VerificationDate; string; The date that the user last updated the authorization status.
- VerifiedBy; string; The user who updated the authorization status.
-
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".
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : publicSectorContractorLicenseAgents
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorContractorLicenseAgents-item-response
Type:
Show Source
object
-
ActiveLastUpdateBy: string
Maximum Length:
64
Indicates the user who last updated the contact active status. -
ActiveLastUpdateDate: string
(date-time)
Indicates the date when the user last updated the contact active status.
-
Address1: string
Title:
Address Line 1
Maximum Length:240
First line of the address of the person who is a contact for the contractor license. -
Address2: string
Title:
Address Line 2
Maximum Length:240
Second line of the address of the person who is a contact for the contractor license. -
Address3: string
Maximum Length:
240
Third line of the address of the person who is a contact for the contractor license. -
Address4: string
Maximum Length:
240
Fourth line of the address of the person who is a contact for the contractor license. -
AssociateDate: string
(date)
The date that the contact person was associated with the contractor license.
-
AuthorizeAgentFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact person is an authorized user of the license. -
AuthorizeStatus: string
Maximum Length:
30
Default Value:PV
Status of the contact person who is associated with the contractor license. The status indicates if the person is a verified contact. -
City: string
Maximum Length:
60
City for the address of the person who is a contact for the contractor license. -
ContactActive: string
Maximum Length:
1
Default Value:Y
Indicates the status for the contact person. -
ContactBizPartyId: integer
(int64)
Business party ID associated with the entity that holds the license.
-
ContactBizProfileId: integer
(int64)
Business Profile ID associated with the contact person if the contact person is a registered user.
-
ContactId: string
Maximum Length:
18
Contact ID associated with the contact person for the business license. This attribute is not currently used. -
ContactPartyId: integer
(int64)
Party ID associated with the contact person if the contact person is a registered user.
-
ContactProfileId: integer
(int64)
Profile ID associated with the contact person if the contact person is a registered user.
-
ContactType: string
Title:
Association Type
Maximum Length:30
The contact type or role of the person associated with the license. This attribute is not currently used. -
Country: string
Title:
Country
Maximum Length:3
Country for the address of the person who is a contact for the contractor license. -
County: string
Maximum Length:
60
Country for the address of the person who is a contact for the contractor license. -
DisassociateDate: string
(date)
The date that a former contact person was disassociated from the contractor license.
-
EmailAddress: string
Title:
Email
Maximum Length:320
Email address of the person who is a contact for the contractor license. -
JobTitle: string
Title:
Title
Maximum Length:60
The job title of the person who is a contact for the contractor license. -
LicenseAgentKey: integer
(int64)
The unique identifier for the person who is an authorized contact for a contractor license.
-
LicenseHolderFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact person is a license holder. -
LicenseKey: integer
(int64)
The unique identifier for a contractor license.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Maximum Length:
360
Name of the organization of the contact person for the contractor license. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
First name of the person who is authorized as a contact for the contractor license. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
Last name of the person who is authorized as a contact for the contractor license. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
Middle name of the person who is authorized as a contact for the contractor license. -
PersonName: 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: string
Title:
Suffix
Maximum Length:30
Name suffix for the person who is authorized as a contact for the contractor license. -
PersonPreNameAdjunct: string
Title:
Salutation
Maximum Length:30
Salutation of the person associated with the contractor license. -
PhoneAreaCode: string
Maximum Length:
10
Phone area code of the person who is a contact for the contractor license. -
PhoneCountryCode: string
Maximum Length:
10
Phone country code of the person who is a contact for the contractor license. -
PhoneExtension: string
Maximum Length:
20
Phone extension of the person who is a contact for the contractor license. -
PhoneNumber: string
Maximum Length:
40
Phone of the person who is a contact for the contractor license. -
PostalCode: string
Title:
ZIP Code
Maximum Length:60
Postal code for the address of the person who is a contact for the contractor license. -
PrimaryFlag: 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: string
Maximum Length:
60
Province for the address of the person who is a contact for the contractor license. -
State: string
Maximum Length:
60
State for the address of the person who is a contact for the contractor license. -
VerificationDate: string
(date)
The date that the user last updated the authorization status.
-
VerifiedBy: string
Maximum Length:
64
The user who updated the authorization status.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.