Jump to

• Request
• Response

Get an item from the cart record

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordCarts/{LnpRecordKey}

Request

Path Parameters

• LnpRecordKey: integer
  The unique identifier for the record key, such as the key for a permit.

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 : publicSectorRecordCarts-item

Type: object

Show Source

• Address1(optional): string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the applicant address.
• Address2(optional): string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the applicant address.
• Address3(optional): string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the applicant address.
• Address4(optional): string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the applicant address.
• Amount(optional): number
  Title: Amount

  The total fees from the source record.
• Applicant(optional): integer(int64)
  Title: Applicant

  The user who submitted the application.
• City(optional): string
  Title: City

  Maximum Length: 60

  The city of the applicant address.
• Country(optional): string
  Title: Country

  Maximum Length: 3

  The applicant country.
• County(optional): string
  Title: County

  Maximum Length: 60

  The country of the applicant address.
• EmailAddress1(optional): string
  Title: Email 1

  Maximum Length: 320

  The applicant first email address.
• EmailAddress2(optional): string
  Title: Email 2

  Maximum Length: 320

  The applicant second email address.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Application

  Maximum Length: 50

  The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
• LnpRecordKey(optional): integer(int64)
  Title: Record

  The unique identifier for the record key, such as the key for a permit.
• PersonFirstName(optional): string
  Title: First Name

  Maximum Length: 150

  The applicant first name.
• PersonLastName(optional): string
  Title: Last Name

  Maximum Length: 150

  The applicant last name.
• PersonMiddleName(optional): string
  Title: Middle Name

  Maximum Length: 60

  The applicant middle name.
• PersonName(optional): string
  Title: Name

  Maximum Length: 450

  The applicant full name.
• PhoneNumber(optional): string
  Title: Phone

  Maximum Length: 60

  The applicant phone number.
• PostalCode(optional): string
  Title: Postal Code

  Maximum Length: 60

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

  Maximum Length: 10

  The postal plus code of the applicant address.
• ProjectKey(optional): integer(int64)
  Title: Project

  The project key associated with this record.
• Province(optional): string
  Title: Province

  Maximum Length: 60

  The province of the applicant address.
• RecordType(optional): string
  Title: Application Type

  Maximum Length: 100

  The record type, such as a permit, business license, professional license, or planning and zoning record.
• RecordTypeId(optional): string
  Maximum Length: 30

  The unique identifier for the record type associated with this item.
• State(optional): string
  Title: State

  Maximum Length: 60

  The state of the applicant address.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the applicant address.",
            "title":"Address Line 1"
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the applicant address.",
            "title":"Address Line 2"
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the applicant address.",
            "title":"Address Line 3"
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the applicant address.",
            "title":"Address Line 4"
        },
        "Amount":{
            "type":"number",
            "description":"The total fees from the source record.",
            "title":"Amount"
        },
        "Applicant":{
            "format":"int64",
            "type":"integer",
            "description":"The user who submitted the application.",
            "title":"Applicant"
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the applicant address.",
            "title":"City"
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The applicant country.",
            "title":"Country"
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The country of the applicant address.",
            "title":"County"
        },
        "EmailAddress1":{
            "maxLength":320,
            "type":"string",
            "description":"The applicant first email address.",
            "title":"Email 1"
        },
        "EmailAddress2":{
            "maxLength":320,
            "type":"string",
            "description":"The applicant second email address.",
            "title":"Email 2"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.",
            "title":"Application"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the record key, such as the key for a permit.",
            "title":"Record"
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The applicant first name.",
            "title":"First Name"
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The applicant last name.",
            "title":"Last Name"
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The applicant middle name.",
            "title":"Middle Name"
        },
        "PersonName":{
            "maxLength":450,
            "type":"string",
            "description":"The applicant full name.",
            "title":"Name"
        },
        "PhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"The applicant phone number.",
            "title":"Phone"
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the applicant address.",
            "title":"Postal Code"
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the applicant address.",
            "title":"Postal Plus 4 Code"
        },
        "ProjectKey":{
            "format":"int64",
            "type":"integer",
            "description":"The project key associated with this record.",
            "title":"Project"
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the applicant address.",
            "title":"Province"
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The record type, such as a permit, business license, professional license, or planning and zoning record.",
            "title":"Application Type"
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the record type associated with this item."
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the applicant address.",
            "title":"State"
        },
        "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