NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Upload a profile photo

post

/spms/v1/guest/photo

This is to upload a profile photo

Request

Supported Media Types

• application/json

Body ()

Required to upload profile photo

Root Schema : profilePhoto

Type: object

Profile Photo

Show Source

• accountId(optional): integer
  Example: 1
• format(optional): string
  Minimum Value: 2

  Maximum Value: 200

  Example: .jpg
• image(optional): string
  Minimum Value: 1

  Maximum Value: 2097152

  Example: /9j/4AAQSkZJRgABAQEASABIAAD==

{
    "description":"Profile Photo",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"integer",
            "example":1
        },
        "format":{
            "type":"string",
            "minimum":2,
            "maximum":200,
            "example":".jpg"
        },
        "image":{
            "type":"string",
            "minimum":1,
            "maximum":2097152,
            "example":"/9j/4AAQSkZJRgABAQEASABIAAD=="
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns updated Profile Photo

Body ()

Root Schema : profilePhoto

Type: object

Profile Photo

Show Source

• accountId(optional): integer
  Example: 1
• format(optional): string
  Minimum Value: 2

  Maximum Value: 200

  Example: .jpg
• image(optional): string
  Minimum Value: 1

  Maximum Value: 2097152

  Example: /9j/4AAQSkZJRgABAQEASABIAAD==

{
    "description":"Profile Photo",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"integer",
            "example":1
        },
        "format":{
            "type":"string",
            "minimum":2,
            "maximum":200,
            "example":".jpg"
        },
        "image":{
            "type":"string",
            "minimum":1,
            "maximum":2097152,
            "example":"/9j/4AAQSkZJRgABAQEASABIAAD=="
        }
    }
}

400 Response

Error when uploaded a corrupted image or image that exceeded 2MB limit

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: [ "Invalid, corrupted or no photo upload", "Uploaded image size exceeded 2 MB" ]
• title(optional): string
  Example: Bad Request
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"Bad Request"
        },
        "detail":{
            "type":"string",
            "example":[
                "Invalid, corrupted or no photo upload",
                "Uploaded image size exceeded 2 MB"
            ]
        }
    }
}

403 Response

This API is not allowed for the current user

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

406 Response

The media supplied is not supported

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

415 Response

The media supplied is not supported

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occurred while processing this request

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available

Back to Top