Jump to

• Request
• Response

Retrieve configured Main Department record.

get

/spms/v2/ships/{shipId}/configurations/financialMainDepartments

This is to retrieve the configured Main Department Codes.

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number
  Ship ID

Query Parameters

• departmentType: string
  Department Type: * `D` - Debit * `C` - Credit
• isActive: boolean
  Minimum Value: 0

  Activation status of the department: * `true` - Department is active * `false` - Department is inactive
• limit: integer(int32)
  Minimum Value: 0

  Paging Limit
• mainDepartmentCode: string
  Main Department Code
• mainDepartmentDescription: string
  Main Department Description
• offset: integer(int32)
  Minimum Value: 0

  Paging Offset
• orderBy: string
  Minimum Value: 0

  Order By departmentType, mainDepartmentCode, mainDepartmentDescription with format column1:asc/desc,column2:asc/desc
• searchValue: string
  Search Value

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object List of Main Departments
  Title: List of Main Departments

  List of Main Departments

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MainDepartmentResponse"
    }
}

Nested Schema : List of Main Departments

Type: object

Title: List of Main Departments

List of Main Departments

Show Source

• count(optional): integer
  Example: 12345678
• hasMore(optional): boolean
  Example: true
• items(optional): array items
• limit(optional): integer
  Example: 10
• offset(optional): integer
  Example: 1

{
    "title":"List of Main Departments",
    "description":"List of Main Departments",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "example":12345678
        },
        "hasMore":{
            "type":"boolean",
            "example":true
        },
        "offset":{
            "type":"integer",
            "example":1
        },
        "limit":{
            "type":"integer",
            "example":10
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MainDepartmentList"
            },
            "example":[
                {
                    "mainDepartmentCode":1001,
                    "mainDepartmentDescription":"Food and Beverage",
                    "departmentType":"D",
                    "isActive":true
                },
                {
                    "mainDepartmentCode":1002,
                    "mainDepartmentDescription":"Credit Card",
                    "departmentType":"C",
                    "isActive":true
                }
            ]
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Main Departments
  Title: Main Departments

  Main Departments

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MainDepartmentList"
    },
    "example":[
        {
            "mainDepartmentCode":1001,
            "mainDepartmentDescription":"Food and Beverage",
            "departmentType":"D",
            "isActive":true
        },
        {
            "mainDepartmentCode":1002,
            "mainDepartmentDescription":"Credit Card",
            "departmentType":"C",
            "isActive":true
        }
    ]
}

Example:

[
    {
        "mainDepartmentCode":1001,
        "mainDepartmentDescription":"Food and Beverage",
        "departmentType":"D",
        "isActive":true
    },
    {
        "mainDepartmentCode":1002,
        "mainDepartmentDescription":"Credit Card",
        "departmentType":"C",
        "isActive":true
    }
]

Nested Schema : Main Departments

Type: object

Title: Main Departments

Main Departments

Show Source

• departmentType(optional): string
  Title: Department Type

  Default Value: Debit

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Department type. Always equal to Debit

  Example: Debit
• isActive(optional): boolean
  Activation status of the user group: * `true` - User group is active * `false` - User group is inactive

  Example: true
• mainDepartmentCode(optional): string
  Maximum Length: 10

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Main Department Code

  Example: 1000
• mainDepartmentDescription(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Main Department Description

  Example: Food and Beverage

{
    "title":"Main Departments",
    "description":"Main Departments",
    "type":"object",
    "properties":{
        "mainDepartmentCode":{
            "$ref":"#/definitions/mainDepartmentCode"
        },
        "mainDepartmentDescription":{
            "$ref":"#/definitions/mainDepartmentDescription"
        },
        "departmentType":{
            "$ref":"#/definitions/departmentType"
        },
        "isActive":{
            "$ref":"#/definitions/isActive"
        }
    }
}

204 Response

No Content

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MainDepartmentConfigurationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Limit must not be less than one!"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Limit must not be less than one!"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MainDepartmentConfigurationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorized",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MainDepartmentConfigurationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource is forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MainDepartmentConfigurationErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MainDepartmentConfigurationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"Request a Mime type that is supported for this Resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MainDepartmentConfigurationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Issue fulfilling request. Please retry or contact support"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MainDepartmentConfigurationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable. Try again later"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable. Try again later"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top