Jump to

• Request
• Response

Get Print Logos

post

/content/sim/v1/setup/getPrintLogos

Gets all the Print Logos configured

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : PrintLogosGetRequest

Type: object

Show Source

• include(optional): string
  Objects included in response

  Example: locations
• languages(optional): string
  If specified, limits translated strings returned

  Example: en-US,es-SS,lt-LT
• limit(optional): integer
  If using paging, number of results returned in this page.

  Example: 10
• offset(optional): integer
  Starting resource record index

  Example: 0
• orderBy(optional): string
  Sorts the response by the specified field name and sort order

  Example: objectNum:asc
• searchCriteria(optional): string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order"
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations",
            "description":"Objects included in response"
        },
        "languages":{
            "type":"string",
            "example":"en-US,es-SS,lt-LT",
            "description":"If specified, limits translated strings returned"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Print Logos objects of the organization

Body ()

Root Schema : PrintLogos

Type: object

Model for Print Logos Object

Show Source

• content(optional): string
  The actual file containing the image.

  Example: abc123
• filename(optional): string
  The name of the image file with extensionSupported extensions - bmp

  Example: ImageAppetizers.bmp
• hierUnitId: integer
  Unique reference of the hierarchy unit where the Print Logos is configured

  Example: 3599
• hierUnitName(optional): object hierUnitName
  A string that contains translations of hierarchy unit name into multiple languages
• hierUnitObjNum(optional): integer
  Object number of the hierarchy unit where the Print Logos is configured

  Example: 26
• name: object name
  A group of string objects representing the name of the Print Logos in configured languages
• objectNum: integer
  Object Number of the Print Logos.

  Example: 1
• size(optional): integer
  The size of the image in bytes.Maximum file size ??? 2 MB

  Example: 1
• url(optional): string
  The URL of the download API which needs to be used to download the actual content file. This is auto generated and does not need to be provided during Add/Update API calls.

  Example: baseURL/content/sim/v1/orgidentifier/printLogos/{hierUnitId}/download

{
    "description":"Model for Print Logos Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the Print Logos is configured",
            "type":"integer",
            "example":3599
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit where the Print Logos is configured",
            "type":"integer",
            "example":26
        },
        "hierUnitName":{
            "description":"A string that contains translations of hierarchy unit name into multiple languages",
            "type":"object",
            "example":{
                "en-US":"Property",
                "de-DE":"Eigentum",
                "ar-AR":"??????????"
            }
        },
        "objectNum":{
            "description":"Object Number of the Print Logos.",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"A group of string objects representing the name of the Print Logos  in configured languages",
            "type":"object",
            "example":{
                "en-US":"Print Logos",
                "de-DE":"Print Logos"
            }
        },
        "size":{
            "description":"The size of the image in bytes.Maximum file size ??? 2 MB",
            "type":"integer",
            "example":1
        },
        "filename":{
            "description":"The name of the image file with extensionSupported extensions - bmp",
            "type":"string",
            "example":"ImageAppetizers.bmp"
        },
        "content":{
            "description":"The actual file containing the image.",
            "type":"string",
            "example":"abc123"
        },
        "url":{
            "description":"The URL of the download API which needs to be used to download the actual content file. This is auto generated and does not need to be provided during Add/Update API calls.",
            "type":"string",
            "example":"baseURL/content/sim/v1/orgidentifier/printLogos/{hierUnitId}/download"
        }
    }
}

Nested Schema : hierUnitName

Type: object

A string that contains translations of hierarchy unit name into multiple languages

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "ar-AR":"??????????"
}

Nested Schema : name

Type: object

A group of string objects representing the name of the Print Logos in configured languages

Example:

{
    "en-US":"Print Logos",
    "de-DE":"Print Logos"
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): 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",
    "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"
        }
    }
}

Back to Top