Jump to

• Request
• Response

Get all application contractor licenses

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordContractorLicenses

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 a contractor license using the primary key criteria. Finder Variables:
    • LnpLicenseKey; integer; The unique identifier of a contractor license.
  • LnpLicensePuidKey: Finds a contractor license using the public unique identifier key criteria. Finder Variables:
    • LnpLicensePuid; string; The unique identifier of a contractor license that is used during the CRM import process.
• 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 : publicSectorRecordContractorLicenses

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/publicSectorRecordContractorLicenses-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 publicSectorRecordContractorLicenses-item

{
    "items":{
        "$ref":"#/definitions/publicSectorRecordContractorLicenses-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 : publicSectorRecordContractorLicenses-item

Type: object

Show Source

• AddedAfterSubmit(optional): string
  Maximum Length: 1

  Indicates that the contractor license was added after application submittal.
• Address1(optional): string
  Maximum Length: 240

  The first address line on the contractor license.
• Address2(optional): string
  Maximum Length: 240

  The second address line on the contractor license.
• Address3(optional): string
  Title: Address Line 3

  Maximum Length: 240

  The third address line on the contractor license.
• Address4(optional): string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address line on the contractor license.
• AgencyId(optional): number
  The agency ID for the transaction.
• ApplicantIsAuthAgentFlag(optional): string
  Maximum Length: 1

  The applicant who is the authorized agent for a contractor license.
• City(optional): string
  Title: City

  Maximum Length: 60

  The city of the address on the contractor license.
• ComplaintDiscloureInd(optional): string
  Maximum Length: 1

  Indicates whether a complaint has been disclosed against license. This attribute is for future use.
• ContractorInUse(optional): string
  Maximum Length: 1

  Indicates whether the contractor is used for the application. The default value is Y.
• Country(optional): string
  Maximum Length: 60

  The country on the address of the contractor license.
• County(optional): string
  Title: County

  Maximum Length: 60

  The county on the address of the contractor license.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• Dba(optional): string
  Maximum Length: 360

  The name the contractor is doing business as.
• EmailAddress(optional): string
  Maximum Length: 320

  The email address on a contractor license.
• Enabled(optional): string
  Indicates whether the license is enabled for use in the application. The default value is Y.
• Entity(optional): string
  Title: Ownership Type

  Maximum Length: 30

  The type of entity that holds the contractor license. For example, the license can be held by a corporation, partnership, or sole proprietor.
• ExpireDate(optional): string(date)
  The expiration date of a contractor license.
• InactiveDate(optional): string(date)
  The date when a contractor license became inactive.
• IntegrationSource(optional): string
  Maximum Length: 30

  The third party that integrates with Oracle to verify contractor licenses.
• InternalLicenseStatus(optional): string
  Maximum Length: 30

  The license status that is assigned by agency staff. This is an internally maintained status that is not related to the status maintained by the licensing organization.
• IntLastUpdateBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who updated the third-party integration data.
• IntLastUpdateDt(optional): string(date)
  Title: Last Updated Date

  The date when the third-party integration data was last updated.
• IntStatusLastUpdateBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who updated the internal license status.
• IntStatusLastUpdateDt(optional): string(date)
  Title: Last Updated Date

  The date when the internal license status was last updated.
• InUseLastUpdateBy(optional): string
  Maximum Length: 64

  The user who last updated the contractor's in use status.
• InUseLastUpdateDate(optional): string(date)
  The date when the contractor's in use status was last updated.
• IssueDate(optional): string(date)
  The date when the contractor license was originally issued or went into effect.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LicenseKey(optional): integer(int64)
  The automatically generated number that uniquely identifies the contractor license.
• LicenseLmfPre(optional): string
  Maximum Length: 10

  The suffix associated with the contractor license number to indicate the Home Improvement Salesperson (HIS) registration number.
• LicenseNumber(optional): string
  Maximum Length: 30

  The contractor license number issued by the government.
• LicenseNumberTwo(optional): string
  Maximum Length: 30

  The number portion of the contractor license.
• LicenseSetupCode(optional): string
  Maximum Length: 30

  The code that identifies which data sections are used for the contractor license.
• LicenseSyncDate(optional): string(date-time)
  The date and time when the license was merged with the contractor license file.
• LicenseType(optional): string
  Maximum Length: 30

  The type of contractor license issued.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpLicenseKey(optional): integer(int64)
  The system-generated number used uniquely to identify the license on the transaction.
• LnpLicensePuid(optional): string
  Maximum Length: 480

  The public unique identifier for the license, which is an alternate key used by the CRM import process.
• LnpRecordId(optional): string
  Title: Record ID

  Maximum Length: 50

  The meaningful transaction identifier.
• LnpRecordKey(optional): integer(int64)
  Title: Record ID

  The unique identifier for the related transaction.
• Name(optional): string
  Maximum Length: 360

  The name on the contractor license.
• ObjectVersionNumber(optional): integer(int32)
  Title: Object Version Number

  The system attribute that captures the incremental version number for an object.
• Owner(optional): string
  Maximum Length: 360

  The owner name or names on the contractor license.
• PhoneAreaCode(optional): string
  Title: Work Phone Country

  Maximum Length: 10

  The phone area code on the contractor license.
• PhoneCountryCode(optional): string
  Title: Work Phone Country Code

  Maximum Length: 10

  The phone country code on the contractor license.
• PhoneExtension(optional): string
  Title: Phone

  Maximum Length: 20

  The phone extension on the contractor license.
• PhoneNumber(optional): string
  Title: Phone

  Maximum Length: 40

  The phone number on the contractor license.
• PostalCode(optional): string
  Maximum Length: 60

  The postal code on the address of the contractor license.
• PostalPlus4Code(optional): string
  Title: Postal Plus 4 Code

  Maximum Length: 60

  The postal plus code on the address of the contractor license.
• Province(optional): string
  Title: Province

  Maximum Length: 60

  The province on the address of the contractor license.
• ReactivateDate(optional): string(date)
  The date when a contractor license was reactivated after a period of inactivity.
• RecordNumber(optional): string
  Maximum Length: 64

  The public unique identifier for the permit record that is used by the CRM import process.
• ReissueDate(optional): string(date)
  The date when a contractor license was reissued, for example, if the entity type has changed.
• SourceStatus(optional): string
  Maximum Length: 100

  The license status as provided by the third-party licensing body that validated the license information.
• State(optional): string
  Title: State

  Maximum Length: 60

  The state on the address of the contractor license.
• SubjectId(optional): string
  Maximum Length: 30

  The attribute used to identify where the data should be displayed.
• SuspendDate(optional): string(date)
  The date when a contractor license was suspended.

{
    "properties":{
        "AddedAfterSubmit":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the contractor license was added after application submittal."
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first address line on the contractor license."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second address line on the contractor license."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third address line on the contractor license.",
            "title":"Address Line 3"
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line on the contractor license.",
            "title":"Address Line 4"
        },
        "AgencyId":{
            "type":"number",
            "description":"The agency ID for the transaction."
        },
        "ApplicantIsAuthAgentFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The applicant who is the authorized agent for a contractor license."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the address on the contractor license.",
            "title":"City"
        },
        "ComplaintDiscloureInd":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a complaint has been disclosed against license. This attribute is for future use."
        },
        "ContractorInUse":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contractor is used for the application. The default value is Y."
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"The country on the address of the contractor license."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county on the address of the contractor license.",
            "title":"County"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "Dba":{
            "maxLength":360,
            "type":"string",
            "description":"The name the contractor is doing business as."
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address on a contractor license."
        },
        "Enabled":{
            "type":"string",
            "description":"Indicates whether  the license is enabled for use in the application. The default value is Y."
        },
        "Entity":{
            "maxLength":30,
            "type":"string",
            "description":"The type of entity that holds the contractor license. For example, the license can be held by a corporation, partnership, or sole proprietor.",
            "title":"Ownership Type"
        },
        "ExpireDate":{
            "format":"date",
            "type":"string",
            "description":"The expiration date of a contractor license."
        },
        "InUseLastUpdateBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contractor's in use status."
        },
        "InUseLastUpdateDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the contractor's in use status was last updated."
        },
        "InactiveDate":{
            "format":"date",
            "type":"string",
            "description":"The date when a contractor license became inactive."
        },
        "IntLastUpdateBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the third-party integration data.",
            "title":"Last Updated By"
        },
        "IntLastUpdateDt":{
            "format":"date",
            "type":"string",
            "description":"The date when the third-party integration data was last updated.",
            "title":"Last Updated Date"
        },
        "IntStatusLastUpdateBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the internal license status.",
            "title":"Last Updated By"
        },
        "IntStatusLastUpdateDt":{
            "format":"date",
            "type":"string",
            "description":"The date when the internal license status was last updated.",
            "title":"Last Updated Date"
        },
        "IntegrationSource":{
            "maxLength":30,
            "type":"string",
            "description":"The third party that integrates with Oracle to verify contractor licenses."
        },
        "InternalLicenseStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The license status that is assigned by agency staff. This is an internally maintained status that is not related to the status maintained by the licensing organization."
        },
        "IssueDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the contractor license was originally issued or went into effect."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LicenseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The automatically generated number that uniquely identifies the contractor license."
        },
        "LicenseLmfPre":{
            "maxLength":10,
            "type":"string",
            "description":"The suffix associated with the contractor license number to indicate the Home Improvement Salesperson (HIS) registration number."
        },
        "LicenseNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The contractor license number issued by the government."
        },
        "LicenseNumberTwo":{
            "maxLength":30,
            "type":"string",
            "description":"The number portion of the contractor license."
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies which data sections are used for the contractor license."
        },
        "LicenseSyncDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the license was merged with the contractor license file."
        },
        "LicenseType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of contractor license issued."
        },
        "LnpLicenseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The system-generated number used uniquely to identify the license on the transaction."
        },
        "LnpLicensePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for the license, which is an alternate key used by the CRM import process."
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The meaningful transaction identifier.",
            "title":"Record ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the related transaction.",
            "title":"Record ID"
        },
        "Name":{
            "maxLength":360,
            "type":"string",
            "description":"The name on the contractor license."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The system attribute that captures the incremental version number for an object.",
            "title":"Object Version Number"
        },
        "Owner":{
            "maxLength":360,
            "type":"string",
            "description":"The owner name or names on the contractor license."
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code on the contractor license.",
            "title":"Work Phone Country"
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code on the contractor license.",
            "title":"Work Phone Country Code"
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone extension on the contractor license.",
            "title":"Phone"
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number on the contractor license.",
            "title":"Phone"
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code on the address of the contractor license."
        },
        "PostalPlus4Code":{
            "maxLength":60,
            "type":"string",
            "description":"The postal plus code on the address of the contractor license.",
            "title":"Postal Plus 4 Code"
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province on the address of the contractor license.",
            "title":"Province"
        },
        "ReactivateDate":{
            "format":"date",
            "type":"string",
            "description":"The date when a contractor license was reactivated after a period of inactivity."
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier for the permit record that is used by the CRM import process."
        },
        "ReissueDate":{
            "format":"date",
            "type":"string",
            "description":"The date when a contractor license was reissued, for example, if the entity type has changed."
        },
        "SourceStatus":{
            "maxLength":100,
            "type":"string",
            "description":"The license status as provided by the third-party licensing body that validated the license information."
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state on the address of the contractor license.",
            "title":"State"
        },
        "SubjectId":{
            "maxLength":30,
            "type":"string",
            "description":"The attribute used to identify where the data should be displayed."
        },
        "SuspendDate":{
            "format":"date",
            "type":"string",
            "description":"The date when a contractor license was suspended."
        },
        "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 : 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"
}

Back to Top