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(required): integer(int64)
  The unique identifier for the person who is an authorized contact for a contractor license.
• LicenseKey(required): integer(int64)
  The automatically generated number that uniquely identifies the contractor license.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorContractorLicenses-ContractorLicenseAgents-item-response

Type: object

Show Source

• ActiveLastUpdateBy: string
  Maximum Length: 64

  The user who last updated the active contact status.
• ActiveLastUpdateDate: string (date-time)
  Date when the user last updated the active status of the contact.
• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The 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

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

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

  The fourth line of the address of the person who is a contact for the contractor license.
• AssociateDate: string (date)
  The date when 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

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

  The city for the address of the person who is a contact for the contractor license.
• ContactActive: string
  Maximum Length: 1

  Default Value: Y

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

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

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

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

  Maximum Length: 320

  The 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

  The name of the organization of the contact person for the contractor license.
• PersonFirstName: string
  Title: First Name

  Maximum Length: 150

  The 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

  The middle name of the person who is authorized as a contact for the contractor license.
• PersonName: 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: string
  Title: Suffix

  Maximum Length: 30

  The name suffix for the person who is authorized as a contact for the contractor license.
• PersonPreNameAdjunct: string
  Title: Salutation

  Maximum Length: 30

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

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

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

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

  The phone of the person who is a contact for the contractor license.
• PostalCode: string
  Title: ZIP Code

  Maximum Length: 60

  The 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

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

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

  The user who updated the authorization status.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the organization of the contact person for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationDate":{
            "type":"string",
            "description":"The date when the user last updated the authorization status.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ContactType":{
            "title":"Association Type",
            "maxLength":"30",
            "type":"string",
            "description":"The contact type or role of the person associated with the license. This attribute is not currently used.",
            "nullable":true,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "title":"Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The name suffix for the person who is authorized as a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"ZIP Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of the person who is authorized as a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "maxLength":"18",
            "type":"string",
            "description":"The contact ID associated with the contact person for the business license. This attribute is not currently used.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactProfileId":{
            "type":"integer",
            "description":"The profile ID associated with the contact person if the contact person is a registered user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The job title of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":"60",
            "type":"string",
            "description":"The country for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseHolderFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the contact person is a license holder.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "AuthorizeAgentFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the contact person is an authorized user of the license.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "LicenseAgentKey":{
            "type":"integer",
            "description":"The unique identifier for the person who is an authorized contact for a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The phone country code of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The phone area code of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactBizPartyId":{
            "type":"integer",
            "description":"The business party ID associated with the entity that holds the license.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssociateDate":{
            "type":"string",
            "description":"The date when the contact person was associated with the contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPartyId":{
            "type":"integer",
            "description":"The party ID associated with the contact person if the contact person is a registered user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonPreNameAdjunct":{
            "title":"Salutation",
            "maxLength":"30",
            "type":"string",
            "description":"The salutation of the person associated with the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactActive":{
            "maxLength":"1",
            "type":"string",
            "description":"The status for the contact person.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of the person who is authorized as a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactBizProfileId":{
            "type":"integer",
            "description":"The business profile ID associated with the contact person if the contact person is a registered user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "DisassociateDate":{
            "type":"string",
            "description":"The date when a former contact person was disassociated from the contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the person who is authorized as a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"The city for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":"60",
            "type":"string",
            "description":"The province for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":"20",
            "type":"string",
            "description":"The phone extension of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveLastUpdateBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the active contact  status.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveLastUpdateDate":{
            "type":"string",
            "description":"Date when the user last updated the active status of the contact.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"The state for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The phone of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "VerifiedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who updated the authorization status.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"The unique identifier for a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "default":"PV",
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top