Configuration and Content API Guide

Update Service Charge Group Details

post

/config/sim/v1/sales/servicechargegroups/updatedetails

Updates the Service Charge Group Detail. If Service Charge Group Detail is not found, it creates a new Service Charge Group Detail.

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string

Detail that identifies, who made the change.

Request body

Root Schema : ServiceChargeGroupDetailUpdateRequestBody

Type: object

Model for ServiceChargeGroupDetail Object

Show Source

hierUnitId(required): integer

Unique reference of the hierarchy unit

Example: 1
objectNum(required): integer

Object number of the Service Charge Group

Example: 1
sequenceNum(required): integer

Sequence number of the service charge group detail in the service charge group

Example: 1
svcObjNum(required): integer

Object number of the service charge

Example: 1

{
    "description":"Model for ServiceChargeGroupDetail Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "sequenceNum",
        "svcObjNum"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the Service Charge Group",
            "type":"integer",
            "example":1
        },
        "sequenceNum":{
            "description":"Sequence number of the service charge group detail in the service charge group",
            "type":"integer",
            "example":1
        },
        "svcObjNum":{
            "description":"Object number of the service charge",
            "type":"integer",
            "example":1
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Service Charge Group Detail Response

Root Schema : ServiceChargeGroupDetailResponse

Type: object

Show Source

hierUnitId(required): integer

Unique reference of the hierarchy unit

Example: 1
objectNum(required): integer

Object number of the Service Charge Group

Example: 1
sequenceNum(required): integer

Sequence number of the service charge group detail in the service charge group

Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "sequenceNum"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the Service Charge Group",
            "type":"integer",
            "example":1
        },
        "sequenceNum":{
            "description":"Sequence number of the service charge group detail in the service charge group",
            "type":"integer",
            "example":1
        }
    }
}

400 Response

400 Bad Request

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

detail(required): string

A short, human-readable summary of the problem.

Example: Specified Data is invalid
errorDetails(required): string

A human-readable explanation specific to this occurrence of the problem.

Example: Entity Does Not Exist
o:errorCode(required): integer

Error code of the problem

Example: 55223
status(required): integer

HTTP status code.

Example: 400
title(required): string

A short, human-readable summary of the problem type.

Example: VALIDATION ERROR
type(required): string

A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}