Jump to

• Request
• Response

Get a contractor license agent

get

/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents/{LicenseAgentKey}

Request

Path Parameters

• LicenseAgentKey: integer
  The unique identifier for the person who is an authorized contact for a contractor license.
• LicenseKey: integer
  The automatically generated number that uniquely identifies the contractor 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
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorContractorLicenses-ContractorLicenseAgents-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

  The first line of the address of the person who is a contact for the contractor license.
• Address2(optional): string
  Maximum Length: 240

  The second line of the address of the person who is a contact for the contractor license.
• Address3(optional): string
  Maximum Length: 240

  The third line of the address of the person who is a contact for the contractor license.
• Address4(optional): string
  Maximum Length: 240

  The fourth line of the address of the person who is a contact for the contractor license.
• AssociateDate(optional): string(date)
  The date when the contact person was associated with the contractor license.
• AuthorizeStatus(optional): string
  Maximum Length: 30

  The status of the contact person who is associated with the contractor license. The status indicates whether the person is a verified contact.
• City(optional): string
  Maximum Length: 60

  The city for the address of the person who is a contact for the contractor license.
• ContactBizPartyId(optional): integer(int64)
  The business party ID associated with the entity that holds the license.
• ContactBizProfileId(optional): integer(int64)
  The business profile ID associated with the contact person if the contact person is a registered user.
• ContactId(optional): string
  Maximum Length: 18

  The contact ID associated with the contact person for the business license. This attribute is not currently used.
• ContactPartyId(optional): integer(int64)
  The party ID associated with the contact person if the contact person is a registered user.
• ContactProfileId(optional): integer(int64)
  The 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

  The country for the address of the person who is a contact for the contractor license.
• County(optional): string
  Maximum Length: 60

  The country for the address of the person who is a contact for the contractor license.
• DisassociateDate(optional): string(date)
  The date when a former contact person was disassociated from the contractor license.
• EmailAddress(optional): string
  Maximum Length: 320

  The 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

  The name of the organization of the contact person for the contractor license.
• PersonFirstName(optional): string
  Maximum Length: 150

  The 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

  The middle name of the person who is authorized as a contact for the contractor license.
• PersonName(optional): string
  Maximum Length: 450

  The 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

  The name suffix for the person who is authorized as a contact for the contractor license.
• PersonPreNameAdjunct(optional): string
  Maximum Length: 30

  The salutation of the person associated with the contractor license.
• PhoneAreaCode(optional): string
  Maximum Length: 10

  The phone area code of the person who is a contact for the contractor license.
• PhoneCountryCode(optional): string
  Maximum Length: 10

  The phone country code of the person who is a contact for the contractor license.
• PhoneExtension(optional): string
  Maximum Length: 20

  The phone extension of the person who is a contact for the contractor license.
• PhoneNumber(optional): string
  Maximum Length: 40

  The phone of the person who is a contact for the contractor license.
• PostalCode(optional): string
  Maximum Length: 60

  The 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

  The province for the address of the person who is a contact for the contractor license.
• State(optional): string
  Maximum Length: 60

  The state for the address of the person who is a contact for the contractor license.
• VerificationDate(optional): string(date)
  The date when the user last updated the authorization status.
• VerifiedBy(optional): string
  Maximum Length: 64

  The user who updated the authorization status.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address of the person who is a contact for the contractor license."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address of the person who is a contact for the contractor license."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address of the person who is a contact for the contractor license."
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address of the person who is a contact for the contractor license."
        },
        "AssociateDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the contact person was associated with the contractor license."
        },
        "AuthorizeStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the contact person who is associated with the contractor license. The status indicates whether the person is a verified contact."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city for the address of the person who is a contact for the contractor license."
        },
        "ContactBizPartyId":{
            "format":"int64",
            "type":"integer",
            "description":"The business party ID associated with the entity that holds the license."
        },
        "ContactBizProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The business profile ID associated with the contact person if the contact person is a registered user."
        },
        "ContactId":{
            "maxLength":18,
            "type":"string",
            "description":"The contact ID associated with the contact person for the business license. This attribute is not currently used."
        },
        "ContactPartyId":{
            "format":"int64",
            "type":"integer",
            "description":"The party ID associated with the contact person if the contact person is a registered user."
        },
        "ContactProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The profile ID associated with the contact person if the contact person is a registered user."
        },
        "ContactType":{
            "maxLength":30,
            "type":"string",
            "description":"The contact type or role of the person associated with the license. This attribute is not currently used."
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country for the address of the person who is a contact for the contractor license."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The country for the address of the person who is a contact for the contractor license."
        },
        "DisassociateDate":{
            "format":"date",
            "type":"string",
            "description":"The date when a former contact person was disassociated from the contractor license."
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the person who is a contact for the contractor license."
        },
        "JobTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The job title of the person who is a contact for the contractor license."
        },
        "LicenseAgentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the person who is an authorized contact for a contractor license."
        },
        "LicenseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a contractor license."
        },
        "OrganizationName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the organization of the contact person for the contractor license."
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person who is authorized as a contact for the contractor license."
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"Last name of the person who is authorized as a contact for the contractor license."
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the person who is authorized as a contact for the contractor license."
        },
        "PersonName":{
            "maxLength":450,
            "type":"string",
            "description":"The 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":{
            "maxLength":30,
            "type":"string",
            "description":"The name suffix for the person who is authorized as a contact for the contractor license."
        },
        "PersonPreNameAdjunct":{
            "maxLength":30,
            "type":"string",
            "description":"The salutation of the person associated with the contractor license."
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code of the person who is a contact for the contractor license."
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code of the person who is a contact for the contractor license."
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone extension of the person who is a contact for the contractor license."
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone of the person who is a contact for the contractor license."
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the address of the person who is a contact for the contractor license."
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies whether the person associated with the license is the preferred contact for the contractor. This attribute is not currently used."
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province for the address of the person who is a contact for the contractor license."
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state for the address of the person who is a contact for the contractor license."
        },
        "VerificationDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the user last updated the authorization status."
        },
        "VerifiedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the authorization status."
        },
        "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