Jump to

• Request
• Response

Create a set of fee schedule maps

post

/fscmRestApi/resources/11.13.18.05/publicSectorFeeScheduleMaps

Request

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.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AgencyId: integer
  The agency identifier of the fee schedule map record.
• EffectiveEndDate: string (date)
  The end date of the fee schedule.
• EffectiveStartDate: string (date)
  The start date of the fee schedule.
• FeeScheduleId: string
  Maximum Length: 20

  The identifier of the fee schedule.
• FeeScheduleLine: integer
  The line number for the fee schedule.
• FieldNum: integer
  The field identifier of the fee schedule map.
• MappingType: string
  Maximum Length: 10

  The mapping type of the fee schedule.
• SourceFieldname: string
  Maximum Length: 50

  The name of source field in the mapping.
• SourceFieldtype: string
  Maximum Length: 30

  The type of source field in the mapping.
• SourceLabel: string
  Maximum Length: 200

  The source field label in the mapping.
• SourceObjectname: string
  Maximum Length: 200

  The name of the source business object for an array.
• TargetFieldname: string
  Maximum Length: 50

  The name of target field in the mapping.
• TargetLabel: string
  Maximum Length: 200

  The target field label in the mapping.
• TargetObjectname: string
  Maximum Length: 200

  The name of the target business object for an array.

{
    "type":"object",
    "properties":{
        "MappingType":{
            "maxLength":10,
            "type":"string",
            "description":"The mapping type of the fee schedule.",
            "nullable":false
        },
        "SourceObjectname":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the source business object for an array.",
            "nullable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the fee schedule map record.",
            "nullable":false
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The end date of the fee schedule.",
            "format":"date",
            "nullable":false
        },
        "FeeScheduleLine":{
            "type":"integer",
            "description":"The line number for the fee schedule. ",
            "nullable":false
        },
        "SourceLabel":{
            "maxLength":200,
            "type":"string",
            "description":"The source field label in the mapping.",
            "nullable":true
        },
        "FieldNum":{
            "type":"integer",
            "description":"The field identifier of the fee schedule map.",
            "nullable":false
        },
        "TargetLabel":{
            "maxLength":200,
            "type":"string",
            "description":"The target field label in the mapping.",
            "nullable":true
        },
        "SourceFieldname":{
            "maxLength":50,
            "type":"string",
            "description":"The name of source field in the mapping.",
            "nullable":true
        },
        "TargetFieldname":{
            "maxLength":50,
            "type":"string",
            "description":"The name of target field in the mapping.",
            "nullable":true
        },
        "SourceFieldtype":{
            "maxLength":30,
            "type":"string",
            "description":"The type of source field in the mapping.",
            "nullable":true
        },
        "FeeScheduleId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the fee schedule.",
            "nullable":false
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The start date of the fee schedule.",
            "format":"date",
            "nullable":false
        },
        "TargetObjectname":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the target business object for an array.",
            "nullable":true
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : publicSectorFeeScheduleMaps-item-response

Type: object

Show Source

• AgencyId: integer
  The agency identifier of the fee schedule map record.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the fee schedule mapping.
• CreatedByLogin: string
  Read Only: true

  Maximum Length: 32

  The login identifier that is used to create the fee schedule mapping.
• CreationDate: string (date-time)
  Read Only: true

  The date when the fee schedule mapping was created.
• EffectiveEndDate: string (date)
  The end date of the fee schedule.
• EffectiveStartDate: string (date)
  The start date of the fee schedule.
• FeeScheduleId: string
  Maximum Length: 20

  The identifier of the fee schedule.
• FeeScheduleLine: integer
  The line number for the fee schedule.
• FieldNum: integer
  The field identifier of the fee schedule map.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the fee schedule mapping was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the fee schedule mapping.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login identifier who last updated the fee schedule mapping.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingType: string
  Maximum Length: 10

  The mapping type of the fee schedule.
• SourceFieldname: string
  Maximum Length: 50

  The name of source field in the mapping.
• SourceFieldtype: string
  Maximum Length: 30

  The type of source field in the mapping.
• SourceLabel: string
  Maximum Length: 200

  The source field label in the mapping.
• SourceObjectname: string
  Maximum Length: 200

  The name of the source business object for an array.
• TargetFieldname: string
  Maximum Length: 50

  The name of target field in the mapping.
• TargetLabel: string
  Maximum Length: 200

  The target field label in the mapping.
• TargetObjectname: string
  Maximum Length: 200

  The name of the target business object for an array.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the fee schedule mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MappingType":{
            "maxLength":10,
            "type":"string",
            "description":"The mapping type of the fee schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectname":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the source business object for an array.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the fee schedule mapping was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the fee schedule mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the fee schedule map record.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The end date of the fee schedule.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FeeScheduleLine":{
            "type":"integer",
            "description":"The line number for the fee schedule. ",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLabel":{
            "maxLength":200,
            "type":"string",
            "description":"The source field label in the mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldNum":{
            "type":"integer",
            "description":"The field identifier of the fee schedule map.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetLabel":{
            "maxLength":200,
            "type":"string",
            "description":"The target field label in the mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceFieldname":{
            "maxLength":50,
            "type":"string",
            "description":"The name of source field in the mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetFieldname":{
            "maxLength":50,
            "type":"string",
            "description":"The name of target field in the mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceFieldtype":{
            "maxLength":30,
            "type":"string",
            "description":"The type of source field in the mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeScheduleId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the fee schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedByLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login identifier that is used to create the fee schedule mapping.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The start date of the fee schedule.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TargetObjectname":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the target business object for an array.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the fee schedule mapping was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login identifier who last updated the fee schedule mapping.",
            "nullable":true,
            "readOnly":true,
            "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